RelationType (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

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

getRoleInfo

public RoleInfo getRoleInfo(String roleInfoName)
                     throws IllegalArgumentException,
                            RoleInfoNotFoundException

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

Parameters:: roleInfoName - 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.

getRoleInfos

public List getRoleInfos()

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

Returns:: an {@link ArrayList} of {@link RoleInfo}.