| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class RelationTypeSupport extends Object implements RelationType
A RelationTypeSupport object implements the RelationType interface.
It represents a relation type, providing role information for each role expected to be supported in every relation of that type.
A relation type includes a relation type name and a list of role infos (represented by RoleInfo objects).
A relation type has to be declared in the Relation Service:
- either using the createRelationType() method, where a RelationTypeSupport object will be created and kept in the Relation Service
- either using the addRelationType() method where the user has to create an object implementing the RelationType interface, and this object will be used as representing a relation type in the Relation Service.
The serialVersionUID of this class is 4611072955724144607L
.
Constructor Summary | |
---|---|
protected |
RelationTypeSupport(String relationTypeName) Constructor to be used for subclasses. |
RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) Constructor where all role definitions are dynamically created and passed as parameter. |
Method Summary | |
---|---|
protected void |
addRoleInfo(RoleInfo roleInfo) Add a role info. |
String |
Returns the relation type name. |
RoleInfo |
getRoleInfo(String roleInfoName) Returns the role info (RoleInfo object) for the given role info name (null if not found). |
List |
Returns the list of role definitions (ArrayList of RoleInfo objects). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected RelationTypeSupport(String relationTypeName)
relationTypeName
- Name of relation type.public RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException
relationTypeName
- Name of relation typeroleInfoArray
- List of role definitions (RoleInfo objects)IllegalArgumentException
- if null parameterInvalidRelationTypeException
- if:
- the same name has been used for two different roles
- no role info provided
- one null role info provided
Method Detail |
---|
protected void addRoleInfo(RoleInfo roleInfo) throws IllegalArgumentException, InvalidRelationTypeException
roleInfo
- role info to be added.IllegalArgumentException
- if null parameter.InvalidRelationTypeException
- if there is already a role
info in current relation type with the same name.public String getRelationTypeName()
public RoleInfo getRoleInfo(String roleInfoName) throws IllegalArgumentException, RoleInfoNotFoundException
roleInfoName
- role info nameIllegalArgumentException
- if null parameterRoleInfoNotFoundException
- if no role info with that name in
relation type.public List getRoleInfos()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |