oracle.owb.foundation.reflection
Interface PropertyDefinition

All Superinterfaces:

OWBNamedObject, Typed

public interface PropertyDefinition

extends OWBNamedObject, Typed

Property definition which can be configuration, logical, core or user-defined property definition.

Author:

Xiaoge Zhang

Method Summary

ClassDefinition	getClassDefinition() Get owning class.
Value	getDefaultValue() Get default value.
java.lang.Object	getDefaultValueObject() Get default value object.
java.lang.String	getDefaultValueString() Get default value in string format.
int	getMaximumStringLength() Get maximum leng of the value.
RoleDefinition	getRoleDefinition() Get associated role.
void	setDefaultValue(Value value) Set default value.
void	setDefaultValueObject(java.lang.Object value) Set default value object.
void	setDefaultValueString(java.lang.String value) Set default value by string.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.domain.Typed

getType

Method Detail

getDefaultValue

public Value getDefaultValue()

Get default value.

Returns:

the default value of the property definition.

See Also:

setDefaultValue(oracle.owb.foundation.domain.Value)

setDefaultValue

public void setDefaultValue(Value value)
                     throws TypeMismatchException

Set default value.

Parameters:

value - is value to be set as default value of the property definition.

Throws:

TypeMismatchException - if the value passed in has incompatible type with the property definition.

See Also:

getDefaultValue()

getDefaultValueObject

public java.lang.Object getDefaultValueObject()
                                       throws TypeMismatchException

Get default value object.

Returns:

the default value of this property definition.

Throws:

TypeMismatchException - if the default value is not scalar value.

See Also:

setDefaultValueObject(java.lang.Object)

setDefaultValueObject

public void setDefaultValueObject(java.lang.Object value)
                           throws TypeMismatchException,
InvalidFormatException

Set default value object.

Parameters:

value - is the object assigned as the default value of the property definition.

Throws:

TypeMismatchException - if the default value is not scalar value.

InvalidFormatException - if the type is primitive type and the format of the value is invalid.

See Also:

getDefaultValueObject()

getDefaultValueString

public java.lang.String getDefaultValueString()
                                       throws TypeMismatchException

Get default value in string format.

Returns:

the default value in string format.

Throws:

TypeMismatchException - if the default value is not scalar value.

See Also:

setDefaultValueString(java.lang.String)

setDefaultValueString

public void setDefaultValueString(java.lang.String value)
                           throws TypeMismatchException,
InvalidFormatException

Set default value by string.

Parameters:

value - is the string format of the default value.

Throws:

TypeMismatchException - if the default value is not primitive value.

InvalidFormatException - if the type is primitive type and the format of the value is invalid.

See Also:

getDefaultValueString()

getRoleDefinition

public RoleDefinition getRoleDefinition()

Get associated role.

Returns:

associated role definition if the property definition is linked with a role.

getClassDefinition

public ClassDefinition getClassDefinition()

Get owning class.

Specified by:

getClassDefinition in interface OWBNamedObject

Returns:

class definition which owns this property definition.

getMaximumStringLength

public int getMaximumStringLength()

Get maximum leng of the value.

Returns:

maximum length of the value if the type of the property is string and has length limit on it.