|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.management.relation.RelationTypeSupport
public class 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(String theRelTypeName)
Constructor to be used for subclasses. |
|
RelationTypeSupport(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. |
String |
getRelationTypeName()
Returns the relation type name. |
RoleInfo |
getRoleInfo(String theRoleInfoName)
Returns the role info (RoleInfo object) for the given role info name (null if not found). |
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(String theRelTypeName,
RoleInfo[] theRoleInfoArray)
throws IllegalArgumentException,
InvalidRelationTypeException
theRelTypeName - Name of relation typetheRoleInfoArray - List of role definitions (RoleInfo objects)
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(String theRelTypeName)
theRelTypeName - Name of relation type.
IllegalArgumentException - if null parameter.| Method Detail |
|---|
public String getRelationTypeName()
getRelationTypeName in interface RelationTypepublic List getRoleInfos()
getRoleInfos in interface RelationTypeArrayList of RoleInfo.
public RoleInfo getRoleInfo(String theRoleInfoName)
throws IllegalArgumentException,
RoleInfoNotFoundException
getRoleInfo in interface RelationTypetheRoleInfoName - role info name
IllegalArgumentException - if null parameter
RoleInfoNotFoundException - if no role info with that name in
relation type.
protected void addRoleInfo(RoleInfo theRoleInfo)
throws IllegalArgumentException,
InvalidRelationTypeException
theRoleInfo - 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.
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.