commonj.sdo
Interface Property


public interface Property

A representation of a Property in the type of a data object.


Method Summary
 java.util.List getAliasNames()
          Return a list of alias names for this Property.
 Type getContainingType()
          Returns the containing type of this Property.
 java.lang.Object getDefault()
          Returns the default value this Property will have in a data object where the Property hasn't been set.
 java.lang.String getName()
          Returns the name of the Property.
 Property getOpposite()
          Returns the opposite Property if the Property is bi-directional or null otherwise.
 Type getType()
          Returns the type of the Property.
 boolean isContainment()
          Returns whether the Property is containment, i.e., whether it represents by-value composition.
 boolean isMany()
          Returns whether the Property is many-valued.
 boolean isReadOnly()
          Returns true if values for this Property cannot be modified using the SDO APIs.
 

Method Detail

getName

public java.lang.String getName()
Returns the name of the Property.

Returns:
the Property name.

getType

public Type getType()
Returns the type of the Property.

Returns:
the Property type.

isMany

public boolean isMany()
Returns whether the Property is many-valued.

Returns:
true if the Property is many-valued.

isContainment

public boolean isContainment()
Returns whether the Property is containment, i.e., whether it represents by-value composition.

Returns:
true if the Property is containment.

getContainingType

public Type getContainingType()
Returns the containing type of this Property.

Returns:
the Property's containing type.
See Also:
Type.getProperties()

getDefault

public java.lang.Object getDefault()
Returns the default value this Property will have in a data object where the Property hasn't been set.

Returns:
the default value.

isReadOnly

public boolean isReadOnly()
Returns true if values for this Property cannot be modified using the SDO APIs. When true, DataObject.set(Property property, Object value) throws an exception. Values may change due to other factors, such as services operating on DataObjects.

Returns:
true if values for this Property cannot be modified.

getOpposite

public Property getOpposite()
Returns the opposite Property if the Property is bi-directional or null otherwise.

Returns:
the opposite Property if the Property is bi-directional or null

getAliasNames

public java.util.List getAliasNames()
Return a list of alias names for this Property.

Returns:
a list of alias names for this Property.