com.sssw.wf.api
Interface EbiProperty

public interface EbiProperty

This class is a name value pair for worflow properties. Workflow properties are assigned to a workitem or a workitem document.

Field Summary

static String	TYPE_BOOLEAN Public constant for property type boolean
static String	TYPE_DOUBLE Public constant for property type double
static String	TYPE_ELEMENT Public constant for property type Element
static String	TYPE_FLOAT Public constant for property type float
static String	TYPE_INT Public constant for property type integer
static String	TYPE_LONG Public constant for property type long
static String	TYPE_STRING Public constant for property type string
static String	TYPE_TIMESTAMP Public constant for property type timestamp

Method Summary

String	getDocumentName() This method returns the document name if property is assigned to a document.
Element	getPropertyElement() This method returns the property value the value is TYPE_ELEMENT.
String	getPropertyName() This method returns the property name.
String	getPropertyType() This method gets the property value type.
String	getPropertyValue() This method returns the property value.
boolean	isDocumentProperty() Return whether the property is a document property
boolean	isImmutable() Return whether the property can be modified
void	setPropertyType(String propertyType) This method sets the property value type.
void	setPropertyValue(String propertyValue) This method sets the property value.
void	storeInto(com.sssw.wf.api.Element propEl) Stores this property into the specified Element.

Field Detail

TYPE_INT

public static final String TYPE_INT

Public constant for property type integer

TYPE_FLOAT

public static final String TYPE_FLOAT

Public constant for property type float

TYPE_DOUBLE

public static final String TYPE_DOUBLE

Public constant for property type double

TYPE_LONG

public static final String TYPE_LONG

Public constant for property type long

TYPE_BOOLEAN

public static final String TYPE_BOOLEAN

Public constant for property type boolean

TYPE_TIMESTAMP

public static final String TYPE_TIMESTAMP

Public constant for property type timestamp

TYPE_STRING

public static final String TYPE_STRING

Public constant for property type string

TYPE_ELEMENT

public static final String TYPE_ELEMENT

Public constant for property type Element

Method Detail

getDocumentName

public String getDocumentName()

This method returns the document name if property is assigned to a document.

Returns:

name - the document name or null

getPropertyName

public String getPropertyName()

This method returns the property name.

Returns:

name - the property name or null

getPropertyValue

public String getPropertyValue()

This method returns the property value. The value is always returned as a string. The properties type should be queried for conversion.

Returns:

value - the property value or null

getPropertyElement

public Element getPropertyElement()

This method returns the property value the value is TYPE_ELEMENT. If it is any other type the method will fail.

Returns:

value - the property value or null

setPropertyValue

public void setPropertyValue(String propertyValue)

This method sets the property value. The value is provided in string form. The property type should be set for conversion.

Returns:

value - the property value or null

getPropertyType

public String getPropertyType()

This method gets the property value type. The type will be one of the allowed types.

Returns:

type - the property value or null

setPropertyType

public void setPropertyType(String propertyType)

This method sets the property value type. The must be one of the allowed types.

Parameters:

value - - the property value or null

isImmutable

public boolean isImmutable()

Return whether the property can be modified

Returns:

isImmutable - true or false

isDocumentProperty

public boolean isDocumentProperty()

Return whether the property is a document property

Returns:

isDocumentProperty - true or false

storeInto

public void storeInto(com.sssw.wf.api.Element propEl)

Stores this property into the specified Element. Opposite of the constructor EboProperty(Element).