org.kuali.rice.kim.document

Class IdentityManagementGroupDocument

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.rice.kim.document.IdentityManagementKimDocument

org.kuali.rice.kim.impl.type.IdentityManagementTypeAttributeTransactionalDocument

org.kuali.rice.kim.document.IdentityManagementGroupDocument

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, Document, SessionDocument, TransactionalDocument

@Entity
public class IdentityManagementGroupDocument
extends IdentityManagementTypeAttributeTransactionalDocument

This is a description of what this class does - bhargavp don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected boolean	editing
protected String	groupDescription
protected String	groupId
protected String	groupName
protected String	groupNamespace
protected String	groupTypeId
protected String	groupTypeName

Fields inherited from class org.kuali.rice.kim.impl.type.IdentityManagementTypeAttributeTransactionalDocument

attributeEntry, attributes, definitions, kimType, kimTypeService

Fields inherited from class org.kuali.rice.kim.document.IdentityManagementKimDocument

delegationMembers, delegations

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

adHocRoutePersons, adHocRouteWorkgroups, documentHeader, documentNumber, notes, pessimisticLocks

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

extension, newCollectionRecord

Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase

objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
IdentityManagementGroupDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(GroupDocumentMember member)
void	doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) Handle the doRouteStatusChange event from the post processor
GroupDocumentMember	getBlankMember()
String	getGroupDescription()
String	getGroupId()
String	getGroupName()
String	getGroupNamespace()
String	getGroupTypeId()
String	getGroupTypeName()
KimType	getKimType()
List<GroupDocumentMember>	getMembers()
GroupDocumentQualifier	getQualifier(String kimAttributeDefnId)
List<GroupDocumentQualifier>	getQualifiers()
Map<String,String>	getQualifiersAsAttributes()
void	initializeDocumentForNewGroup()
boolean	isActive()
boolean	isEditing()
void	prepareForSave() This method provides a hook that will be called before the document is saved.
void	setActive(boolean active)
void	setDefinitions(List<KimAttributeField> definitions)
void	setEditing(boolean editing)
void	setGroupDescription(String groupDescription)
void	setGroupId(String groupId)
void	setGroupName(String groupName)
void	setGroupNamespace(String groupNamespace)
void	setGroupTypeId(String groupTypeId)
void	setGroupTypeName(String groupTypeName)
void	setKimType(KimType kimType)
void	setMembers(List<GroupDocumentMember> members)
void	setQualifiers(List<GroupDocumentQualifier> qualifiers)
void	setRoleId(String groupId)

Methods inherited from class org.kuali.rice.kim.impl.type.IdentityManagementTypeAttributeTransactionalDocument

getAttributeEntry, getAttributes, getCommaDelimitedAttributesLabels, getDefinitions, getDefinitionsKeyedByAttributeName, getKimTypeService, setAttributes

Methods inherited from class org.kuali.rice.kim.document.IdentityManagementKimDocument

addDelegationMemberToDelegation, getDelegationId, getDelegationMembers, getDelegations, getKimAttributeDefnId, getPrimaryDelegation, getSecondaryDelegation, setDelegationMembers, setDelegations

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getActionRequests, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearingMethodNames, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getSuperUserAnnotation, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, postRemove, prepareForSave, prePersist, processAfterRetrieve, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, setSuperUserAnnotation, toCopy, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord

Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase

generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, preUpdate, setExtensionObject, setObjectId, setVersionNumber, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getActionRequests, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearingMethodNames, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getSuperUserAnnotation, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, setSuperUserAnnotation, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Field Detail

groupId

protected String groupId

groupTypeId

protected String groupTypeId

groupTypeName

protected String groupTypeName

groupNamespace

protected String groupNamespace

groupName

protected String groupName

groupDescription

protected String groupDescription

active

protected boolean active

editing

protected boolean editing

Constructor Detail

IdentityManagementGroupDocument

public IdentityManagementGroupDocument()

Method Detail

isActive

public boolean isActive()

Returns:

the active

setActive

public void setActive(boolean active)

Parameters:

active - the active to set

setRoleId

public void setRoleId(String groupId)

Parameters:

groupId - the groupId to set

addMember

public void addMember(GroupDocumentMember member)

Parameters:

member - the members to set

getKimType

public KimType getKimType()

Overrides:

getKimType in class IdentityManagementTypeAttributeTransactionalDocument

Returns:

the kimType

getBlankMember

public GroupDocumentMember getBlankMember()

doRouteStatusChange

public void doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent)

Description copied from interface: Document

Handle the doRouteStatusChange event from the post processor

Specified by:

doRouteStatusChange in interface Document

Overrides:

doRouteStatusChange in class DocumentBase

Parameters:

statusChangeEvent - status change event

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

prepareForSave

public void prepareForSave()

Description copied from interface: Document

This method provides a hook that will be called before the document is saved. This method is useful for applying document level data to children. For example, if someone changes data at the document level, and that data needs to be propagated to child objects or child lists of objects, you can use this method to update the child object or iterate through the list of child objects and apply the document level data to them. Any document that follows this paradigm will need to make use of this method to apply all of those changes.

Specified by:

prepareForSave in interface Document

Overrides:

prepareForSave in class DocumentBase

See Also:

Document.prepareForSave()

initializeDocumentForNewGroup

public void initializeDocumentForNewGroup()

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

Parameters:

groupId - the groupId to set

getGroupName

public String getGroupName()

Returns:

the groupName

setGroupName

public void setGroupName(String groupName)

Parameters:

groupName - the groupName to set

getGroupDescription

public String getGroupDescription()

setGroupDescription

public void setGroupDescription(String groupDescription)

getGroupNamespace

public String getGroupNamespace()

Returns:

the groupNamespace

setGroupNamespace

public void setGroupNamespace(String groupNamespace)

Parameters:

groupNamespace - the groupNamespace to set

getGroupTypeId

public String getGroupTypeId()

Returns:

the groupTypeId

setGroupTypeId

public void setGroupTypeId(String groupTypeId)

Parameters:

groupTypeId - the groupTypeId to set

getGroupTypeName

public String getGroupTypeName()

Returns:

the groupTypeName

setGroupTypeName

public void setGroupTypeName(String groupTypeName)

Parameters:

groupTypeName - the groupTypeName to set

getMembers

public List<GroupDocumentMember> getMembers()

Returns:

the members

setMembers

public void setMembers(List<GroupDocumentMember> members)

Parameters:

members - the members to set

getQualifiers

public List<GroupDocumentQualifier> getQualifiers()

Returns:

the qualifiers

setQualifiers

public void setQualifiers(List<GroupDocumentQualifier> qualifiers)

Parameters:

qualifiers - the qualifiers to set

getQualifier

public GroupDocumentQualifier getQualifier(String kimAttributeDefnId)

getQualifiersAsAttributes

public Map<String,String> getQualifiersAsAttributes()

setDefinitions

public void setDefinitions(List<KimAttributeField> definitions)

Overrides:

setDefinitions in class IdentityManagementTypeAttributeTransactionalDocument

isEditing

public boolean isEditing()

setEditing

public void setEditing(boolean editing)

setKimType

public void setKimType(KimType kimType)

Overrides:

setKimType in class IdentityManagementTypeAttributeTransactionalDocument

Parameters:

kimType - the kimType to set