com.ibm.itim.dataservices.model.system
Class SystemUserEntity

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.DirectoryObjectEntity
        |
        +--com.ibm.itim.dataservices.model.domain.AccountEntity
              |
              +--com.ibm.itim.dataservices.model.system.SystemUserEntity

All Implemented Interfaces:

java.io.Serializable

public class SystemUserEntity

extends AccountEntity

Represents a usr of the system (platform) in the data model. Although this class name indicates it represents a user, it is really just a specialization of an account hosted on the provisioning platform.

See Also:

Serialized Form

Field Summary

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

OWNER

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

ORGANIZATION, PARENT

Constructor Summary

SystemUserEntity(SystemUser systemUser)
Constructs with a value object.

Method Summary

void	addDelegate(Delegate newDelegate) Adds a delegation for the user.
void	addRole(SystemRoleEntity role) Adds the given role to the SystemUser's role (group) memberships.
java.util.Collection	getDelegates() Returns the delegations the user has defined.
java.util.Collection	getRoles() Returns the system roles (groups) the user is a member of (if any).
boolean	isSystemAdmin() Returns true if the SystemUser has a SystemRole in the SystemAdmin Category.
boolean	removeDelegate(Delegate removeDelegate) Removes a delegation for the user.
void	removeRole(SystemRoleEntity role) Removes the given role from the user's role (group) memberships.
void	setIsDelegated(boolean isDelegated) Changes the current delegation flag.
void	updateDelegate(Delegate oldVersion, Delegate newVersion) Replaces the old delegation with the new delegation.

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

addComplianceIssue, adopt, getComplianceIssues, getOwner, getService, isOrphan, orphan, remove, removeAllIssues, removeComplianceIssue, update, update

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

equals, getDirectoryObject, getDistinguishedName, getEntity, getLifecycle, getParent, getParentDN, getProfile, getRelationship, getSupportedRelationships, hashCode, isSupportedRelationship, remove, setLifecycle, toString, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SystemUserEntity

public SystemUserEntity(SystemUser systemUser)

Constructs with a value object.

Parameters:

systemUser - SystemUser object holding the attributes of the system user.

Method Detail

getRoles

public java.util.Collection getRoles()
                              throws ModelCommunicationException,
                                     ModelIntegrityException

Returns the system roles (groups) the user is a member of (if any).

Returns:

Collection of SystemRoleEntities representing the system roles (groups) the user is a member of.

Throws:

ModelCommunicationException - Thrown if unable communicate with the data store.

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the evaluation of the relationship.

addRole

public void addRole(SystemRoleEntity role)
             throws ModelCommunicationException,
                    ObjectNotFoundException

Adds the given role to the SystemUser's role (group) memberships.

Parameters:

role - RoleEntity representing the role (group) to add.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

removeRole

public void removeRole(SystemRoleEntity role)
                throws ModelCommunicationException,
                       ObjectNotFoundException

Removes the given role from the user's role (group) memberships.

Parameters:

role - SystemRoleEntity representing the role (group) to remove.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getDelegates

public java.util.Collection getDelegates()

Returns the delegations the user has defined. A delegation is defined by a user acting as the delegate and a time frame for the delegation (see Delegate).

Returns:

Collection of Delegates representing the user's delegations.

addDelegate

public void addDelegate(Delegate newDelegate)
                 throws ModelCommunicationException,
                        ObjectNotFoundException

Adds a delegation for the user. A delegation is defined by a user acting as the delegate and a time frame for the delegation (see Delegate).

Parameters:

newDelegate - Delegate representing the delegation.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

removeDelegate

public boolean removeDelegate(Delegate removeDelegate)
                       throws ModelCommunicationException,
                              ObjectNotFoundException

Removes a delegation for the user.

Parameters:

removeDelegate - Delegate representing the delegation to remove.

Returns:

True if the given Delegate exists and is successfully removed.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

updateDelegate

public void updateDelegate(Delegate oldVersion,
                           Delegate newVersion)
                    throws ModelCommunicationException,
                           ObjectNotFoundException

Replaces the old delegation with the new delegation.

Parameters:

oldVersion - Delegate to be replaced.

newVersion - Delegate to replace oldVersion.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

setIsDelegated

public void setIsDelegated(boolean isDelegated)
                    throws ModelCommunicationException,
                           ObjectNotFoundException

Changes the current delegation flag. When set to true, the user's responsibilities are currently being delegated.

Parameters:

isDelegated - True if the user's responsibilities are currently delegated, false if not.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

isSystemAdmin

public boolean isSystemAdmin()
                      throws ModelCommunicationException,
                             ModelIntegrityException

Returns true if the SystemUser has a SystemRole in the SystemAdmin Category.

Returns:

True if the SystemUser has a SystemRole in the SystemAdmin Category.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the evaluation of the SystemUser's roles.