RelationType

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> management >> [ relation overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.management.relation.RelationType

SOURCE |

Download javax.management.relation.RelationType

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.relation
Interface RelationType

All Superinterfaces:: java.io.Serializable

All Known Implementing Classes:: RelationTypeSupport

public interface RelationType
extends java.io.Serializable

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

The class RelationTypeSupport 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.

Version:: $Revision: 1.1 $

Method Summary

java.lang.String getRelationTypeName()
          Retrieves the name of this relation type.

RoleInfo getRoleInfo(java.lang.String roleInfoName)
          Retrieves the role info for a role name.

java.util.List getRoleInfos()
          Retrieves the list of role definitions in this relation type.

Method Detail

getRelationTypeName

public java.lang.String getRelationTypeName()

Retrieves the name of this relation type.

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.

getRoleInfo

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

Retrieves the role info for a role name.