com.ibm.itim.dataservices.model.domain
Class Role

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.DirectoryEntry
        |
        +--com.ibm.itim.dataservices.model.DirectoryObject
              |
              +--com.ibm.itim.dataservices.model.domain.Role

All Implemented Interfaces:

com.ibm.itim.util.xml.objectstream.Importable, ProtectedObject, java.io.Serializable

Direct Known Subclasses:

DynamicRole

public class Role

extends DirectoryObject

Value Object class that holds the attribute information of a role in the data model. This class describes the attributes and behaviors associated with any role (static or dynamic). A static role is sufficiently represented by this class. A dynamic role is represented by the sub-class DynamicRole.

See Also:

RoleEntity, DynamicRole, Serialized Form

Field Summary

static java.lang.String	ROLE_ATTR_DESCRIPTION String constant for the description attribute name.
static java.lang.String	ROLE_ATTR_NAME String constant for the naming attribute name.

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE

Constructor Summary

Role()
Default empty constructor

Role(AttributeValues attrs)
Constructs object with attribute information.

Method Summary

java.lang.String	getDescription() Returns the description of the role.
java.lang.String	getName() Returns the logical name of the role.
void	setDescription(java.lang.String description) Changes the description of the role.

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject

addAttribute, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getTenantDN, isLifecycleDefined, removeAttribute, removeAttribute, removeAttribute, setAccessRights, setAttribute, setAttributes, setAuthorizationOwners, setProfileName, setTenantDN, toString

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

clearChange, clearChanges, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_ATTR_NAME

public static java.lang.String ROLE_ATTR_NAME

String constant for the naming attribute name.

ROLE_ATTR_DESCRIPTION

public static java.lang.String ROLE_ATTR_DESCRIPTION

String constant for the description attribute name.

Constructor Detail

Role

public Role()

Default empty constructor

Role

public Role(AttributeValues attrs)

Constructs object with attribute information. Warning: the purpose of this constructor is to provide clients with the ability to create value objects for creation in the data store. Do not use this constructor to create value objects that represent existing entities. See the RoleSearch object for achieving that.

Parameters:

attrs - AttributeValues holding the attributes of the role.

Method Detail

getName

public java.lang.String getName()

Returns the logical name of the role.

Overrides:

getName in class DirectoryObject

Returns:

String representing logical name of the role.

getDescription

public java.lang.String getDescription()

Returns the description of the role.

Returns:

Description of the role (String).

setDescription

public void setDescription(java.lang.String description)

Changes the description of the role.

Parameters:

description - New String description of the role.