KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > management > relation > RelationType


1 /*
2  * @(#)RelationType.java 1.17 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */

7
8 package javax.management.relation;
9
10 import java.util.ArrayList JavaDoc; // for Javadoc
11
import java.util.List JavaDoc;
12
13 import java.io.Serializable JavaDoc;
14
15 /**
16  * The RelationType interface has to be implemented by any class expected to
17  * represent a relation type.
18  *
19  * @since 1.5
20  */

21 public interface RelationType extends Serializable JavaDoc {
22
23     //
24
// Accessors
25
//
26

27     /**
28      * Returns the relation type name.
29      *
30      * @return the relation type name.
31      */

32     public String JavaDoc getRelationTypeName();
33
34     /**
35      * Returns the list of role definitions (ArrayList of RoleInfo objects).
36      *
37      * @return an {@link ArrayList} of {@link RoleInfo}.
38      */

39     public List JavaDoc getRoleInfos();
40
41     /**
42      * Returns the role info (RoleInfo object) for the given role info name
43      * (null if not found).
44      *
45      * @param theRoleInfoName role info name
46      *
47      * @return RoleInfo object providing role definition
48      * does not exist
49      *
50      * @exception IllegalArgumentException if null parameter
51      * @exception RoleInfoNotFoundException if no role info with that name in
52      * relation type.
53      */

54     public RoleInfo JavaDoc getRoleInfo(String JavaDoc theRoleInfoName)
55     throws IllegalArgumentException JavaDoc,
56            RoleInfoNotFoundException JavaDoc;
57 }
58
Popular Tags