XMOJO 5 API Docs

javax.management.relation
Class RelationTypeSupport

java.lang.Object
  |
  +--javax.management.relation.RelationTypeSupport
All Implemented Interfaces:
RelationType, java.io.Serializable

public class RelationTypeSupport
extends java.lang.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.

See Also:
Serialized Form

Constructor Summary
protected RelationTypeSupport(java.lang.String theRelTypeName)
          Constructs a RelationTypeSupport with the relation type name specified.
  RelationTypeSupport(java.lang.String theRelTypeName, RoleInfo[] theRoleInfoArray)
          Constructor where all role definitions are dynamically created and passed as parameter.
 
Method Summary
protected  void addRoleInfo(RoleInfo theRoleInfo)
           
 java.lang.String getRelationTypeName()
          Returns the relation type name.
 RoleInfo getRoleInfo(java.lang.String theRoleInfoName)
          Returns the role info (RoleInfo object) for the given role info name (null if not found).
 java.util.List getRoleInfos()
          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

RelationTypeSupport

protected RelationTypeSupport(java.lang.String theRelTypeName)
Constructs a RelationTypeSupport with the relation type name specified.
Parameters:
theRelTypeName - The string argument specifying the name for RelationTypeSupport

RelationTypeSupport

public RelationTypeSupport(java.lang.String theRelTypeName,
                           RoleInfo[] theRoleInfoArray)
                    throws java.lang.IllegalArgumentException,
                           InvalidRelationTypeException
Constructor where all role definitions are dynamically created and passed as parameter.
Parameters:
theRelTypeName - - Name of relation type
theRoleInfoArray - - List of role definitions (RoleInfo objects)
Throws:
java.lang.IllegalArgumentException - - if null parameter
InvalidRelationTypeException - - if: - the same name has been used for two different roles - no role info provided - one null role info provided
Method Detail

addRoleInfo

protected void addRoleInfo(RoleInfo theRoleInfo)
                    throws java.lang.IllegalArgumentException,
                           InvalidRelationTypeException

getRelationTypeName

public java.lang.String getRelationTypeName()
Returns the relation type name. Specified by: getRelationTypeName in interface RelationType
Specified by:
getRelationTypeName in interface RelationType
Returns:
The frelation type name

getRoleInfo

public RoleInfo getRoleInfo(java.lang.String theRoleInfoName)
                     throws java.lang.IllegalArgumentException,
                            RoleInfoNotFoundException
Returns the role info (RoleInfo object) for the given role info name (null if not found). Specified by: getRoleInfo in interface RelationType
Specified by:
getRoleInfo in interface RelationType
Parameters:
theRoleInfoName - - role info name
Returns:
RoleInfo object providing role definition does not exist
Throws:
java.lang.IllegalArgumentException - - if null parameter
RoleInfoNotFoundException - - if no role info with that name in relation type.

getRoleInfos

public java.util.List getRoleInfos()
Returns the list of role definitions (ArrayList of RoleInfo objects). Specified by getRoleInfos in interface RelationType
Specified by:
getRoleInfos in interface RelationType
Returns:
The list of role definitions

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.