javax.management.relation
Interface RelationType

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RelationTypeSupport (src)

public interface RelationType

extends java.io.Serializable

This interface is implemented by a class that represents a relation.

The class RelationTypeSupport (src) is available to help implement this interface.

A relation type has a name and a list of role info objects for the relation.

A relation type has to registered in the relation service. This is done either by using createRelationType() to get a RelationTypeSupport object kepy in the relation service, or by using addRelationType() to add an external relation type to the relation service.

getRelationTypeName

public java.lang.String getRelationTypeName()

Retrieves the name of this relation type.

Returns:

the name.

getRoleInfos

public java.util.List getRoleInfos()

Retrieves the list of role definitions in this relation type.

The return value is a list of RoleInfo objects. The list must be an ArrayList.

Returns:

the list of Role Infos.

getRoleInfo

public RoleInfo (src)  getRoleInfo(java.lang.String roleInfoName)
                     throws java.lang.IllegalArgumentException,
                            RoleInfoNotFoundException (src) 

Retrieves the role info for a role name.

Returns:

the role info or null.

Throws:

java.lang.IllegalArgumentException - for a null role info name.

RoleInfoNotFoundException (src) - for no role info with the passed name in the relation type.