| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.management.relation.RelationTypeSupport
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.
| Constructor Summary | |
| protected  | RelationTypeSupport(java.lang.String theRelTypeName)Constructor to be used for subclasses. | 
|   | 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)Add a role info. | 
|  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 | 
public RelationTypeSupport(java.lang.String theRelTypeName,
                           RoleInfo[] theRoleInfoArray)
                    throws java.lang.IllegalArgumentException,
                           InvalidRelationTypeException
theRelTypeName - Name of relation typetheRoleInfoArray - List of role definitions (RoleInfo objects)
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
protected RelationTypeSupport(java.lang.String theRelTypeName)
theRelTypeName - Name of relation type.
java.lang.IllegalArgumentException - if null parameter.| Method Detail | 
public java.lang.String getRelationTypeName()
getRelationTypeName in interface RelationTypepublic java.util.List getRoleInfos()
getRoleInfos in interface RelationTypeArrayList of RoleInfo.
public RoleInfo getRoleInfo(java.lang.String theRoleInfoName)
                     throws java.lang.IllegalArgumentException,
                            RoleInfoNotFoundException
getRoleInfo in interface RelationTypetheRoleInfoName - role info name
java.lang.IllegalArgumentException - if null parameter
RoleInfoNotFoundException - if no role info with that name in
 relation type.
protected void addRoleInfo(RoleInfo theRoleInfo)
                    throws java.lang.IllegalArgumentException,
                           InvalidRelationTypeException
theRoleInfo - role info to be added.
java.lang.IllegalArgumentException - if null parameter.
InvalidRelationTypeException - if there is already a role
  info in current relation type with the same name.| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.