org.cristalise.kernel.collection

Interface CollectionMember

All Known Implementing Classes:

AggregationMember, DependencyMember

public interface CollectionMember

CollectionMembers are pointers to individual Items in a collection. Under certain circumstances they may be empty, or they can be created and destroyed as required. They can hold properties containing annotations about the link, including information on the typing of the Item they should point to. Properties that dictate type information are specified in the ClassProps, and assignment of an Item will fail if those member properties do not match the Property values of the Item attempting to be assigned, throwing a MembershipException detailing the mismatches.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignItem(ItemPath itemPath) Assign the given item to the slot, if it fits
void	clearItem() De-assign the slot, leaving it empty.
String	getChildUUID() Returns the UUID of the currently assigned Item
String	getClassProps() Gets the class properties, which specify type information in child Items.
int	getID() Get the integer slot ID, as generated by the parent Collection
ItemPath	getItemPath() Returns the current assigned ItemPath
CastorHashMap	getProperties() Gets the member properties.
ItemProxy	resolveItem() Resolve the Item currently assigned

Method Detail

getItemPath

ItemPath getItemPath()

Returns the current assigned ItemPath

Returns:

the ItemPath, null if empty

getChildUUID

String getChildUUID()

Returns the UUID of the currently assigned Item

Returns:

assignItem

void assignItem(ItemPath itemPath)
                throws InvalidCollectionModification

Assign the given item to the slot, if it fits

Parameters:

itemPath - The item to assign

Throws:

MembershipException - When the Item Properties don't match the typing specification in ClassProps and Properties

InvalidCollectionModification

clearItem

void clearItem()

De-assign the slot, leaving it empty.

resolveItem

ItemProxy resolveItem()
                      throws ObjectNotFoundException

Resolve the Item currently assigned

Returns:

the ItemProxy of the assigned Item

Throws:

ObjectNotFoundException - When empty

getID

int getID()

Get the integer slot ID, as generated by the parent Collection

Returns:

ID

getProperties

CastorHashMap getProperties()

Gets the member properties.

Returns:

CastorHashMap

getClassProps

String getClassProps()

Gets the class properties, which specify type information in child Items. On instantiation from a CollectionDescription, the ClassProps are generated from the PropertyDescriptions which have the isClassIdentifier boolean set to true.

Returns:

Comma-separated list of property names that relate to Item type