Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.management.relation
Class RelationTypeSupport

    java.lang.Object
      javax.management.relation.RelationTypeSupport

All Implemented Interfaces:
  Serializable, RelationType

    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.

Since:
  1.5
See Also:
  Serialized Form

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

### RelationTypeSupport

    public RelationTypeSupport(String theRelTypeName,
                               RoleInfo[] theRoleInfoArray)
                        throws 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:
    `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

### RelationTypeSupport

    protected RelationTypeSupport(String theRelTypeName)

  Constructor to be used for subclasses.

  Parameters:
    `theRelTypeName` - Name of relation type.
  Throws:
    `IllegalArgumentException` - if null parameter.

Method Detail

### getRelationTypeName

    public String getRelationTypeName()

  Returns the relation type name.

  Specified by:
    `getRelationTypeName` in interface `RelationType`
  Returns:
    the relation type name.

### getRoleInfos

    public List getRoleInfos()

  Returns the list of role definitions (ArrayList of RoleInfo objects).

  Specified by:
    `getRoleInfos` in interface `RelationType`
  Returns:
    an `ArrayList` of `RoleInfo`.

### getRoleInfo

    public RoleInfo getRoleInfo(String theRoleInfoName)
                         throws IllegalArgumentException,
                                RoleInfoNotFoundException

  Returns the role info (RoleInfo object) for the given role info name (null if not found).

  Specified by:
    `getRoleInfo` in interface `RelationType`
  Parameters:
    `theRoleInfoName` - role info name
  Returns:
    RoleInfo object providing role definition does not exist
  Throws:
    `IllegalArgumentException` - if null parameter
    `RoleInfoNotFoundException` - if no role info with that name in relation type.

### addRoleInfo

    protected void addRoleInfo(RoleInfo theRoleInfo)
                        throws IllegalArgumentException,
                               InvalidRelationTypeException

  Add a role info. This method of course should not be used after the creation of the relation type, because updating it would invalidate that the relations created associated to that type still conform to it. Can throw a RuntimeException if trying to update a relation type declared in the Relation Service.

  Parameters:
    `theRoleInfo` - role info to be added.
  Throws:
    `IllegalArgumentException` - if null parameter.
    `InvalidRelationTypeException` - if there is already a role info in current relation type with the same name.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.