com.webmethods.portal.service.portlet.info

Interface IPortletPropertyInfo

public interface IPortletPropertyInfo

Portlet property information defined in the portlet descriptor file as:

<!-- definition of the 'property1' portlet property --> <attribute> <name>property1</name> <!-- the required tag defines whether the property is required possible values: "true" - the property is required "false" - the property is not required --> <required>false</required> <!-- the default tag defines the default value of the property --> <default></default> <!-- type defines the type of the property. possible values: "content" - the value is persisted in the db per portlet instance "config" - the value is persisted in the db per portlet type "user" - the value is persisted in the db per user. "session" - the value is persisted on in the session (NOTE: only for PCA portlets) --> <type>session</type> <!-- the editor tag defines how the property is edited --> <editor> <!-- the displayName tag defines the text used in the UI for this property --> <displayName>Property 1</displayName> <!-- the group tag defines the property group this property belongs in. --> <group>group1</group> <!-- the validate tag defines a regular expression used to validate the input --> <validate></validate> <!-- the validateerrormsg tag defines the error message to display if validation fails --> <validateerrormsg></validateerrormsg> </editor> </attribute>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DBO_DATA_TYPE_BOOLEAN
static int	DBO_DATA_TYPE_CLOB
static int	DBO_DATA_TYPE_DATETIME
static int	DBO_DATA_TYPE_FLOAT
static int	DBO_DATA_TYPE_INTEGER
static int	DBO_DATA_TYPE_INVALID
static int	DBO_DATA_TYPE_LONG
static int	DBO_DATA_TYPE_STRING
static int	EDITOR_TYPE_DYNAMIC Deprecated.
static int	EDITOR_TYPE_INPUT Deprecated.
static int	EDITOR_TYPE_SELECT Deprecated.
static int	PROPERTY_TYPE_ALL
static int	PROPERTY_TYPE_ATTR Property type - attribute.
static int	PROPERTY_TYPE_CONFIG Property type - config.
static int	PROPERTY_TYPE_CONTENT Property type - content.
static int	PROPERTY_TYPE_RELATED_CHILDREN Property type - related children.
static int	PROPERTY_TYPE_RELATED_CONTAINERS Property type - related children.
static int	PROPERTY_TYPE_SESSION Property type - user.
static int	PROPERTY_TYPE_SYSTEM This type is for system properties defined by the system at run-time.
static int	PROPERTY_TYPE_USER Property type - user.
static int	SUBTYPE_SIMPLE Deprecated.
static int	SUBTYPE_THINGID Deprecated.

Method Summary

Modifier and Type	Method and Description
int	getDBODataLength() Valid only for DBO type portlets, otherwise return (-1).
int	getDBODataType() Valid only for DBO type portlets, otherwise returns (-1).
String	getDBOFieldName() Returns DBO table field name for this property.
String	getDefaultValue() Returns default value of the property.
Object	getDefaultValues() Returns default value of the property as either a String[] or String depending on what value it was set with.
String	getEditorDescription() Display description for property.
Object	getEditorInfo() Deprecated. use getPropertyEditor method instead
String	getEditorTitle() Get the Display Name for the property
int	getEditorType() Deprecated. use getPropertyEditorType method instead
String	getGroupName() Returns group name this property belongs to
String	getName() Returns the name of the property.
Map<String,Object>	getPropertyEditorParams() Returns a map of property editor parameters
String	getPropertyEditorType() Returns property editor type.
String	getPropertyLineType() Deprecated. use getPropertyEditorType instead
int	getSubtype() Deprecated. not used anymore
int	getType() Returns the type of the property
String	getValidateErrorMessage() Returns validation error message to be shown when property value doesn't match validate regular expression
String	getValidateExpression() Returns property validate regular expression.
boolean	hasDefaultValue() Checks if the property has a default value
boolean	isHidden() Returns whether the propert is hidden in the property editor
boolean	isReadOnly() Returns whether the property is readonly in the property editor
boolean	isRequired() Is property required
void	setDefaultValue(String value) Sets default value of the property
void	setEditorInfo(Object info) Deprecated. not used anymore
void	setEditorType(int type) Deprecated.
void	setHidden(boolean value) Sets hidden flag
void	setReadOnly(boolean value) Sets readonly flag
void	setSubtype(int value) Deprecated. not used anymore
void	setType(int value) Sets a new property type.

Field Detail

PROPERTY_TYPE_ATTR

static final int PROPERTY_TYPE_ATTR

Property type - attribute. This type of property is described in the TLDX as:
<attribute> .. <attr>true</attr> .. </attribute> The attribute value is not designed to be changed by end user.

See Also:

Constant Field Values

PROPERTY_TYPE_SYSTEM

static final int PROPERTY_TYPE_SYSTEM

This type is for system properties defined by the system at run-time.

See Also:

Constant Field Values

PROPERTY_TYPE_CONTENT

static final int PROPERTY_TYPE_CONTENT

Property type - content. This type of property is described in TLDX as
<attribute> .. <type>content</type> .. </attribute>
This type of properties are persisted per portlet intance

See Also:

Constant Field Values

PROPERTY_TYPE_CONFIG

static final int PROPERTY_TYPE_CONFIG

Property type - config. This type of property is described in TLDX as
<attribute> .. <type>config</type> .. </attribute> This type of properties can be changed only by the portal administrator

See Also:

Constant Field Values

PROPERTY_TYPE_USER

static final int PROPERTY_TYPE_USER

Property type - user. This type of property is described in TLDX as
<attribute> .. <type>user</type> .. </attribute>
This type of property is designed to support per user property storage

See Also:

Constant Field Values

PROPERTY_TYPE_SESSION

static final int PROPERTY_TYPE_SESSION

Property type - user. This type of property is described in TLDX as
<attribute> .. <type>session</type> .. </attribute>
This type of property is designed to support user session property storage

See Also:

Constant Field Values

PROPERTY_TYPE_RELATED_CHILDREN

static final int PROPERTY_TYPE_RELATED_CHILDREN

Property type - related children. This type of property is necessary for JSR 170 API to call IRelationService.getRelatedIDs(com.webmethods.portal.service.meta2.thing.IThingID, int, int, int) when a relation should be considered as property

Since:

8.0

See Also:

Constant Field Values

PROPERTY_TYPE_RELATED_CONTAINERS

static final int PROPERTY_TYPE_RELATED_CONTAINERS

Property type - related children. This type of property is necessary for JSR 170 API to call IRelationService.getContainerIDs(com.webmethods.portal.service.meta2.thing.IThingID, int, int, int) when a relation should be considered as property

Since:

8.0

See Also:

Constant Field Values

PROPERTY_TYPE_ALL

static final int PROPERTY_TYPE_ALL

See Also:

Constant Field Values

EDITOR_TYPE_INPUT

@Deprecated
static final int EDITOR_TYPE_INPUT

Deprecated.

Type of the property editor - simple input box. This is default value

See Also:

Constant Field Values

EDITOR_TYPE_SELECT

@Deprecated
static final int EDITOR_TYPE_SELECT

Deprecated.

Type of the property editor - select box with static list of values.
<attribute> <editor> <displayName>Dynamic List </displayName> <select> <option value=1>option 1 <option value=2>option 2 <option value=3>option 3 </select> </editor> </attribute>

See Also:

Constant Field Values

EDITOR_TYPE_DYNAMIC

@Deprecated
static final int EDITOR_TYPE_DYNAMIC

Deprecated.

Type of the property editor - dynamically created html by a JSP page.
<attribute> <editor> <displayName>Dynamic List</displayName> <dynamicCreate>property_getlist</dynamicCreate> </editor> </attribute>

See Also:

Constant Field Values

DBO_DATA_TYPE_INVALID

static final int DBO_DATA_TYPE_INVALID

See Also:

Constant Field Values

DBO_DATA_TYPE_STRING

static final int DBO_DATA_TYPE_STRING

See Also:

Constant Field Values

DBO_DATA_TYPE_BOOLEAN

static final int DBO_DATA_TYPE_BOOLEAN

See Also:

Constant Field Values

DBO_DATA_TYPE_INTEGER

static final int DBO_DATA_TYPE_INTEGER

See Also:

Constant Field Values

DBO_DATA_TYPE_LONG

static final int DBO_DATA_TYPE_LONG

See Also:

Constant Field Values

DBO_DATA_TYPE_FLOAT

static final int DBO_DATA_TYPE_FLOAT

See Also:

Constant Field Values

DBO_DATA_TYPE_DATETIME

static final int DBO_DATA_TYPE_DATETIME

See Also:

Constant Field Values

DBO_DATA_TYPE_CLOB

static final int DBO_DATA_TYPE_CLOB

See Also:

Constant Field Values

SUBTYPE_SIMPLE

@Deprecated
static final int SUBTYPE_SIMPLE

Deprecated.

See Also:

Constant Field Values

SUBTYPE_THINGID

@Deprecated
static final int SUBTYPE_THINGID

Deprecated.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of the property. Cannot be null or empty string. The name of the property should be unique among all the properties of the portlet.

Returns:

name of the property

getType

int getType()

Returns the type of the property

Returns:

type of the property

See Also:

PROPERTY_TYPE_CONTENT, PROPERTY_TYPE_CONFIG, PROPERTY_TYPE_USER, PROPERTY_TYPE_SESSION

setType

void setType(int value)

Sets a new property type.

Parameters:

value - the new property type

See Also:

getType()

getDefaultValue

String getDefaultValue()

Returns default value of the property. Can return null if there is no default value.

Returns:

property default value

See Also:

setDefaultValue(java.lang.String), hasDefaultValue()

getDefaultValues

Object getDefaultValues()

Returns default value of the property as either a String[] or String depending on what value it was set with. Can return null if there is no default value.

Returns:

property default value

See Also:

setDefaultValue(java.lang.String), hasDefaultValue()

hasDefaultValue

boolean hasDefaultValue()

Checks if the property has a default value

Returns:

true if the property has a default value

setDefaultValue

void setDefaultValue(String value)

Sets default value of the property

Parameters:

value - new default value of the property

See Also:

getDefaultValue()

isRequired

boolean isRequired()

Is property required

Returns:

true if property is required

getEditorTitle

String getEditorTitle()

Get the Display Name for the property

Returns:

the display name of the property

getEditorDescription

String getEditorDescription()

Display description for property.

getEditorType

@Deprecated
int getEditorType()

Deprecated. use getPropertyEditorType method instead

Returns type of the property editor.

Returns:

type of the property editor

See Also:

EDITOR_TYPE_INPUT, EDITOR_TYPE_SELECT

setEditorType

@Deprecated
void setEditorType(int type)

Deprecated.

Sets a new type of the property editor

Parameters:

type - new property editor type

See Also:

not used anymore

getEditorInfo

@Deprecated
Object getEditorInfo()

Deprecated. use getPropertyEditor method instead

Returns additional information about property editor. Depends on getEditorType(). For EDITOR_TYPE_INPUT it is null
For EDITOR_TYPE_SELECT it is ArrayList of String[]. String[0] is option value. String[1] is option title.

Returns:

additional information about the property editor

See Also:

getEditorType()

setEditorInfo

@Deprecated
void setEditorInfo(Object info)

Deprecated. not used anymore

Updates additional property editor info.

Parameters:

info - new info object

See Also:

getEditorInfo()

getValidateExpression

String getValidateExpression()

Returns property validate regular expression. I.e. property value should match this regular expression.

Returns:

regexp validation expression

getValidateErrorMessage

String getValidateErrorMessage()

Returns validation error message to be shown when property value doesn't match validate regular expression

Returns:

validation error message

isReadOnly

boolean isReadOnly()

Returns whether the property is readonly in the property editor

Returns:

true is the property is readonly

setReadOnly

void setReadOnly(boolean value)

Sets readonly flag

Parameters:

value - new value for the flag

isHidden

boolean isHidden()

Returns whether the propert is hidden in the property editor

Returns:

true if the property is hidden in the property editor

setHidden

void setHidden(boolean value)

Sets hidden flag

Parameters:

value - new value for the flag

getGroupName

String getGroupName()

Returns group name this property belongs to

Returns:

group name

getSubtype

@Deprecated
int getSubtype()

Deprecated. not used anymore

Returns property subtype name. Subtype is type specific.

Returns:

subtype of the property

setSubtype

@Deprecated
void setSubtype(int value)

Deprecated. not used anymore

Sets the property subtype

Parameters:

value - new subtype value

getPropertyLineType

@Deprecated
String getPropertyLineType()

Deprecated. use getPropertyEditorType instead

Returns property editor type supported by PropertyLineTag 'property_line_type' property.

Returns:

See Also:

PropertyLineTag

getPropertyEditorType

String getPropertyEditorType()

Returns property editor type.

Returns:

See Also:

com.webmethods.portal.taglib.ui.component.PropertyEditorTag

getPropertyEditorParams

Map<String,Object> getPropertyEditorParams()

Returns a map of property editor parameters

Returns:

getDBODataType

int getDBODataType()

Valid only for DBO type portlets, otherwise returns (-1). Returns defined database type for this property of the DBO. See DBO_DATA_TYPE_XXX constants

Returns:

getDBODataLength

int getDBODataLength()

Valid only for DBO type portlets, otherwise return (-1). Returns define database type length for this property

Returns:

getDBOFieldName

String getDBOFieldName()

Returns DBO table field name for this property. May be null, then field name will be assumed the same as property name

Returns: