RoleUnresolved (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
Class RoleUnresolved

java.lang.Object
  javax.management.relation.RoleUnresolved

All Implemented Interfaces:: Serializable

public class RoleUnresolved
extends Object
implements Serializable

Represents an unresolved role: a role not retrieved from a relation due to a problem. It provides the role name, value (if problem when trying to set the role) and an integer defining the problem (constants defined in RoleStatus).

See Also:: Serialized Form

Constructor Summary

RoleUnresolved(String theRoleName, List theRoleValue, int thePbType)
          Constructor.

Method Summary

Object clone()
          Clone this object.

int getProblemType()
          Retrieves problem type.

String getRoleName()
          Retrieves role name.

List getRoleValue()
          Retrieves role value.

void setProblemType(int thePbType)
          Sets problem type.

void setRoleName(String theRoleName)
          Sets role name.

void setRoleValue(List theRoleValue)
          Sets role value.

String toString()
          Return a string describing this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoleUnresolved

public RoleUnresolved(String theRoleName,
                      List theRoleValue,
                      int thePbType)
               throws IllegalArgumentException

Constructor.
Parameters:: theRoleName - name of the role; theRoleValue - value of the role (if problem when setting the role); thePbType - type of problem (according to known problem types, listed as static final members).
Throws:: IllegalArgumentException - if null parameter or incorrect problem type

Method Detail

getRoleName

public String getRoleName()

Retrieves role name.

Returns:: the role name.
See Also:: setRoleName(java.lang.String)

getRoleValue

public List getRoleValue()

Retrieves role value.

Returns:: an ArrayList of ObjectName objects, the one provided to be set in given role. Null if the unresolved role is returned for a read access.
See Also:: setRoleValue(java.util.List)

getProblemType

public int getProblemType()

Retrieves problem type.

Returns:: an integer corresponding to a problem, those being described as static final members of current class.
See Also:: setProblemType(int)

setRoleName

public void setRoleName(String theRoleName)
                 throws IllegalArgumentException

Sets role name.

Parameters:: theRoleName - the new role name.
Throws:: IllegalArgumentException - if null parameter
See Also:: getRoleName()

setRoleValue

public void setRoleValue(List theRoleValue)

Sets role value.

Parameters:: theRoleValue - ArrayList of ObjectName objects for referenced MBeans not set in role.
See Also:: getRoleValue()

setProblemType

public void setProblemType(int thePbType)
                    throws IllegalArgumentException

Sets problem type.

Parameters:: thePbType - integer corresponding to a problem. Must be one of those described as static final members of current class.
Throws:: IllegalArgumentException - if incorrect problem type
See Also:: getProblemType()

clone

public Object clone()

Clone this object.

Returns:: an independent clone.

toString

public String toString()

Return a string describing this object.

Returns:: a description of this RoleUnresolved object.