com.baan.b3.boi1.metadata
Interface IMemberMetadata

All Known Subinterfaces:

IPrimalMemberMetadata

public interface IMemberMetadata

Describes a member of a BusinessObject.

Version:

Build Nr 61, file version \\main\\4, 15:09:03 24-07-2006 UTC

See Also:

IBusinessObjectMetadata

Field Summary

static int

INFINITE_CARDINALITY Constant that indicates an unlimited maximum cardinality.

Method Summary

int	getCardinalityMax() Gives the maximum cardinality for this member.
int	getCardinalityMin() Gives the minimum cardinality for this member.
java.lang.String[]	getDescription() Gets a description of this member.
java.lang.String	getName() Gives the identifier of this member.
IObjectMetadata	getType() Gives the type of this member.
java.lang.Object	getValue(java.lang.Object p_instance) Retrieves the value of this member for a specified Business Object.
boolean	isAttribute() Reveals wether this member is an Element or an Attribute.
boolean	isReadOnly() Gets the read only flag of this member.
void	setValue(java.lang.Object p_instance, java.lang.Object p_value) Sets the value of this member for a specified Business Object.

Field Detail

INFINITE_CARDINALITY

public static final int INFINITE_CARDINALITY

Constant that indicates an unlimited maximum cardinality.

Method Detail

getName

public java.lang.String getName()

Gives the identifier of this member.
The identifier should not be confused with the type.
Threading policy: MTSafe

Returns:

the identifier of this member

getType

public IObjectMetadata getType()

Gives the type of this member.
Threading policy: MTSafe

Returns:

the object type of this member

getCardinalityMax

public int getCardinalityMax()

Gives the maximum cardinality for this member.
The cardinality indicates the number of objects of this member's type that can/must be referenced by this member's identifier.
Threading policy: MTSafe

Returns:

the maximum number of objects referred to by this member. Must be greater that 0. INFINITE_CARDINALITY indicates that there is no maximum

getCardinalityMin

public int getCardinalityMin()

Gives the minimum cardinality for this member.
The cardinality indicates the number of objects of this member's type that can/must be referenced by this member's identifier.
Threading policy: MTSafe

Returns:

the minimum number of objects referred to by this member. Must be greater than or equal to 0.

getValue

public java.lang.Object getValue(java.lang.Object p_instance)
                          throws java.lang.IllegalArgumentException

Retrieves the value of this member for a specified Business Object.
Preconditions: p_instance is in a valid state
Threading policy: Unsafe

Parameters:

p_instance - the Business Object for which this member should be queried

Returns:

the value of this member for p_instance, or null if it is not defined. Primal values that map to primitive java types are returned using the standard java object wrappers (eg. an int is returned as a java.lang.Integer object). Values for members with a maximum cardinality greater than 1 are returned as an array of the relevant type (this array may be empty)

Throws:

java.lang.IllegalArgumentException - if p_instance is null or not of the right Business Object type.

setValue

public void setValue(java.lang.Object p_instance,
                     java.lang.Object p_value)
              throws java.lang.IllegalArgumentException

Sets the value of this member for a specified Business Object.
Preconditions: p_instance is in a valid state
Postconditions: p_instance's member (described by this metadata object) has been set to the specified value
Threading policy: Unsafe

Parameters:

p_instance - the Business Object for which this member should be set

p_value - the value to set for this member in p_instance. null can be used to indicate the absence of an optional member. Primal values that map to primitive java types should be passed using the standard java object wrappers (eg. an int is passed as a java.lang.Integer object). Values for members with a maximum cardinality greater than 1 are passed as an array of the relevant type (the array may be empty).

Throws:

java.lang.IllegalArgumentException - if p_instance is null or either argument is of the wrong type

getDescription

public java.lang.String[] getDescription()

Gets a description of this member.
The description can be multiple lines long.
Threading policy: MTSafe.

Returns:

a multiline string. The array can have length 0.

isReadOnly

public boolean isReadOnly()

Gets the read only flag of this member.
Members can be read only. This means that it will not be possible to set the value of such a member.
Threading policy: MTSafe.

Returns:

the read only flag of this member.

isAttribute

public boolean isAttribute()

Reveals wether this member is an Element or an Attribute.
Members can be Elements or Attributes. With this method this can be distinguished.
Threading policy: MTSafe.

Returns:

true if this member is an Attribute, false if it is an Element.