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

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.DirectoryObject
          com.ibm.itim.dataservices.model.domain.Role
              com.ibm.itim.dataservices.model.domain.DynamicRole

All Implemented Interfaces:

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

public class DynamicRole
extends Role

Value Object class that holds the attribute information of a dynamic role in the data model.

See Also:

DynamicRoleEntity, Serialized Form

Field Summary

static java.lang.String	DEFINITION Constant for the definition (LDAP filter rule) attribute name.
static java.lang.String	PROFILE_NAME Constant defining the dynamic role profile name.
static java.lang.String	SCOPE Constant for the scope attribute name.
static int	SINGLE_LEVEL_SCOPE Constant defining a scope of single level.
static int	SUBTREE_SCOPE Constant defining a sub-tree scope.

Fields inherited from class com.ibm.itim.dataservices.model.domain.Role

HELPDESK_ROLE, isMultiValue, isSingleValue, OWNER, ROLE_ATTR_ASSIGNMENT_KEY, ROLE_ATTR_CLASSIFICATION, ROLE_ATTR_DESCRIPTION, ROLE_ATTR_NAME, ROLE_ATTR_POLICY_TARGET, ROLE_ATTR_SUBROLES, ROLE_CLASSIFICATION_NONE, SERVICEOWNER_ROLE, SUPERVISOR_ROLE, SYSTEMADMIN_ROLE

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

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, ATTR_URI, DESCRIPTION, NAME

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

DynamicRole()
Default empty constructor

DynamicRole(AttributeValues attributes)
Constructs object with attribute information.

DynamicRole(DirectoryObject dirObj)
Copy Constructor

Method Summary

java.lang.String	getDefinition() Returns the definition (rule) of the dynamic role.
int	getScope() Returns the scope of the role.
void	setDefinition(java.lang.String definition) Replaces the definition (rule) of the dynamic role.
void	setScope(int scope) Changes the scope of the role.

Methods inherited from class com.ibm.itim.dataservices.model.domain.Role

equals, getClassification, getDescription, getOwnerDNs, getPolicyTarget, hashCode, removeOwnerDNs, setClassification, setDescription, setOwnerDNs, setPolicyTarget

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

addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getName, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getSortValue, getTenantDN, isLifecycleDefined, 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

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SINGLE_LEVEL_SCOPE

public static final int SINGLE_LEVEL_SCOPE

Constant defining a scope of single level. This is to be used if the role should only affect people in the same logical container as the role.

See Also:

Constant Field Values

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

Constant defining a sub-tree scope. This is to be used if the role should affect people in the same logical container as the role and all subordinate containers.

See Also:

Constant Field Values

DEFINITION

public static final java.lang.String DEFINITION

Constant for the definition (LDAP filter rule) attribute name.

See Also:

Constant Field Values

SCOPE

public static final java.lang.String SCOPE

Constant for the scope attribute name.

See Also:

Constant Field Values

PROFILE_NAME

public static java.lang.String PROFILE_NAME

Constant defining the dynamic role profile name.

Constructor Detail

DynamicRole

public DynamicRole()

Default empty constructor

DynamicRole

public DynamicRole(AttributeValues attributes)

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 DynamicRoleSearch object for achieving that.

Parameters:

attributes - AttributeValues holding the attributes of the dynamic role.

DynamicRole

public DynamicRole(DirectoryObject dirObj)

Copy Constructor

Method Detail

getDefinition

public java.lang.String getDefinition()

Returns the definition (rule) of the dynamic role.

Returns:

String definition (rule) of the dynamic role. This is an LDAP filter rule.

setDefinition

public void setDefinition(java.lang.String definition)

Replaces the definition (rule) of the dynamic role.

Parameters:

definition - New String definition (rule) of the dynamic role. This is an LDAP filter rule that defines the attributes of users that will receive the role. For example, (departmentnumber=audit123) may be used to select all members in an auditing department that is named audit123.

getScope

public int getScope()

Returns the scope of the role. The scope defines what set of people this dynamic role may affect.

Returns:

Enumerated int representing the scope. Possible values are SINGLE_LEVEL_SCOPE and SUBTREE_SCOPE. Default is SINGLE_LEVEL_SCOPE

setScope

public void setScope(int scope)

Changes the scope of the role. The scope defines what set of people this dynamic role may affect.

Parameters:

scope - Enumerated int representing the scope. Possible values are SINGLE_LEVEL_SCOPE and SUBTREE_SCOPE.