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

java.lang.Object
  extended by com.ibm.itim.dataservices.model.DirectoryObjectEntity
      extended by com.ibm.itim.dataservices.model.domain.RoleEntity
All Implemented Interfaces:
com.ibm.itim.util.Sortable, java.io.Serializable
Direct Known Subclasses:
DynamicRoleEntity

public class RoleEntity
extends DirectoryObjectEntity

Represents a Role in the data model.

See Also:
Serialized Form

Field Summary
static java.lang.String ORGANIZATION
          Constant (String) for the organization relationship name.
static java.lang.String OWNER
          Constant (String ) for the owner relationship name
 
Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObjectEntity
PARENT
 
Fields inherited from interface com.ibm.itim.util.Sortable
ATTR_NAME
 
Constructor Summary
RoleEntity(Role role)
          Constructs a Role with a value object.
 
Method Summary
 java.util.Collection getMembers()
          Returns all members of the role.
 java.util.Collection getMembers(java.util.Collection returnAttributes)
          Returns all members of the role.
 OrganizationEntity getOrganization()
          Returns the organization of the current object.
 java.util.Collection<PersonEntity> getOwner()
          Returns the role administration owner if any.
 void update()
          Overwrites base implement to validate object class and include "eraccessitem" class and then Updates the attributes of the entity in the data store.
 void update(DirectoryObject updObject)
          Deprecated. please use update()
 
Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObjectEntity
equals, getDirectoryObject, getDistinguishedName, getEntity, getLifecycle, getObjectCategory, getParent, getParentDN, getProfile, getRelationship, getSortValue, getSupportedRelationships, hashCode, isSupportedRelationship, remove, remove, setLifecycle, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ORGANIZATION

public static final java.lang.String ORGANIZATION
Constant (String) for the organization relationship name.

See Also:
Constant Field Values

OWNER

public static final java.lang.String OWNER
Constant (String ) for the owner relationship name

See Also:
Constant Field Values
Constructor Detail

RoleEntity

public RoleEntity(Role role)
Constructs a Role with a value object.

Parameters:
role - Role object holding the attributes of the role.
Method Detail

getMembers

public java.util.Collection getMembers()
                                throws ModelCommunicationException,
                                       ModelIntegrityException
Returns all members of the role.

Returns:
Collection of PersonEntities that are members of the role.
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 relationship.

getMembers

public java.util.Collection getMembers(java.util.Collection returnAttributes)
                                throws ModelCommunicationException,
                                       ModelIntegrityException
Returns all members of the role.

Parameters:
returnAttributes - Collection of attributes contained in the PersonEntity objects returned by this method.
Returns:
Collection of PersonEntities that are members of the role.
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 relationship.

getOrganization

public OrganizationEntity getOrganization()
                                   throws ModelCommunicationException,
                                          ModelIntegrityException
Returns the organization of the current object.

Returns:
OrganizationEntity representing the object's organization.
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 relationship.

update

public void update(DirectoryObject updObject)
            throws ModelCommunicationException,
                   ObjectNotFoundException
Deprecated. please use update()

Overwrites base implement to validate object class and include "eraccessitem" class and then Updates the attributes of the entity in the data store. An DirectoryObject value object is used to obtain the changes that need to be made.

Overrides:
update in class DirectoryObjectEntity
Parameters:
updObject - DirectoryObject that holds the changes.
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 a data integrity problem, or the entity may have been removed by another client.
Since:
TIM 5.0

update

public void update()
            throws ModelCommunicationException,
                   ObjectNotFoundException
Overwrites base implement to validate object class and include "eraccessitem" class and then Updates the attributes of the entity in the data store. An DirectoryObject value object is used to obtain the changes that need to be made.

Overrides:
update in class DirectoryObjectEntity
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 a data integrity problem, or the entity may have been removed by another client.

getOwner

public java.util.Collection<PersonEntity> getOwner()
                                            throws ModelCommunicationException,
                                                   ModelIntegrityException
Returns the role administration owner if any.

Returns:
Collection of PersonEntity representing the user who is the administration owner of the access; it returns null if no owner is defined
Throws:
ModelCommunicationException - Thrown if unable to communicate with the data store.
ModelIntegrityException - Thrown if unable to locate the related organization. This may be due to a data integrity problem.
Since:
TIM 5.0


IBM Tivoli Identity Manager 5.0
© Copyright International Business Machines Corporation 2007. All rightsreserved. US Government Users Restricited RightsUse, duplication or disclosure restricted by GSA ADP ScheduleContract with IBM Corp.