RelationType (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.relation
Interface RelationType

All Superinterfaces:: Serializable

All Known Implementing Classes:: RelationTypeSupport

public interface RelationType
extends Serializable

The RelationType interface has to be implemented by any class expected to represent a relation type.

Method Summary

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).

Method Detail

getRelationTypeName

public String getRelationTypeName()

Returns the relation type name.

Returns:: the relation type name.

getRoleInfos

public List getRoleInfos()

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

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).

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.