com.ibm.itim.dataservices.model.domain

Class GroupEntity

java.lang.Object

com.ibm.itim.dataservices.model.DirectoryObjectEntity

com.ibm.itim.dataservices.model.domain.GroupEntity

All Implemented Interfaces:

com.ibm.itim.util.Sortable, java.io.Serializable

public class GroupEntity
extends DirectoryObjectEntity

This class represents a group in the data model. Group defines collection of users to be administered collectively for access control. This class provides the interface to retrieve and update the information of group in the data repository and the interface and to return other related objects.

Since:

Tivoli Identity Governance 5.1

See Also:

Serialized Form

Field Summary

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

ORGANIZATION, PARENT

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

ATTR_NAME

Constructor Summary

Constructors

Constructor and Description
GroupEntity(DirectoryObject group) Constructs a GroupEntity with a Group value object.
GroupEntity(Group group) Constructs a GroupEntity with a Group value object.

Method Summary

Modifier and Type	Method and Description
void	clearAccess() Clears the access information that is defined on the group.
AccessInfo	getAccessInfo() Returns any access information that is defined.
java.util.Collection<PersonEntity>	getOwner() Returns the access owner if any.
ServiceEntity	getService() Returns the Tivoli Identity Governance managed identity service to which the group applies.
void	setAccessInfo(AccessInfo access) Defines the access information on the group.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupEntity

public GroupEntity(Group group)

Constructs a GroupEntity with a Group value object.

Parameters:

group - The value object that contains the group information

GroupEntity

public GroupEntity(DirectoryObject group)

Constructs a GroupEntity with a Group value object.

Parameters:

group - The value object that contains the group information

Method Detail

getService

public ServiceEntity getService()
                         throws ModelCommunicationException,
                                ObjectNotFoundException

Returns the Tivoli Identity Governance managed identity service to which the group applies.

Returns:

ServiceEntity represents the associated service of the group

Throws:

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

ModelIntegrityException - Thrown if unable to locate the related organization. This might be caused by a data integrity problem.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This might be caused by a data integrity problem, or the entity might have been removed by another client.

getOwner

public java.util.Collection<PersonEntity> getOwner()
                                            throws ModelCommunicationException,
                                                   ModelIntegrityException

Returns the access owner if any.

Returns:

PersonEntity represents 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 might be caused by a data integrity problem.

getAccessInfo

public AccessInfo getAccessInfo()
                         throws ModelCommunicationException,
                                ObjectNotFoundException

Returns any access information that is defined.

Returns:

AccessInfo holding the access information.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This might be because a distinguished name is not valid, or the entity might have been removed by another client.

setAccessInfo

public void setAccessInfo(AccessInfo access)
                   throws ModelCommunicationException,
                          ObjectNotFoundException

Defines the access information on the group.

Parameters:

access - The AcessInfo object holds the access information.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This might be because a distinguished name is not valid, or the entity might have been removed by another client.

clearAccess

public void clearAccess()
                 throws ModelCommunicationException,
                        ObjectNotFoundException

Clears the access information that is defined on the group.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This might be because the entity might have been removed by another client.