org.kuali.rice.kim.document
Class IdentityManagementGroupDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.rice.kim.document.IdentityManagementKimDocument
                      org.kuali.rice.kim.document.IdentityManagementTypeAttributeTransactionalDocument
                          org.kuali.rice.kim.document.IdentityManagementGroupDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BusinessObject, PersistableBusinessObject, Document, SessionDocument, TransactionalDocument

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

protected boolean	active
protected boolean	editing
protected String	groupDescription
protected String	groupId
protected String	groupName
protected String	groupNamespace
protected String	groupTypeId
protected String	groupTypeName
private static org.apache.log4j.Logger	LOG
private List<GroupDocumentMember>	members
private List<GroupDocumentQualifier>	qualifiers
private static long	serialVersionUID

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

attributeEntry, attributes, definitions, kimType, kimTypeService

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

delegationMembers, delegations, sequenceAccessorService

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

documentBusinessObject, documentHeader, documentNumber

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

IdentityManagementGroupDocument()

Method Summary

void	addMember(GroupDocumentMember member)
void	doRouteStatusChange(DocumentRouteStatusChangeDTO statusChangeEvent) Handle the doRouteStatusChange event from the post processor
GroupDocumentMember	getBlankMember()
String	getGroupDescription()
String	getGroupId()
String	getGroupName()
String	getGroupNamespace()
String	getGroupTypeId()
String	getGroupTypeName()
KimTypeInfo	getKimType()
List<GroupDocumentMember>	getMembers()
GroupDocumentQualifier	getQualifier(String kimAttributeDefnId)
List<GroupDocumentQualifier>	getQualifiers()
AttributeSet	getQualifiersAsAttributeSet()
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(AttributeDefinitionMap 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(KimTypeInfo kimType)
void	setMembers(List<GroupDocumentMember> members)
void	setQualifiers(List<GroupDocumentQualifier> qualifiers)
void	setRoleId(String groupId)

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

getAttributeEntry, getAttributes, getCommaDelimitedAttributesLabels, getDefinitions, getDefinitionsKeyedByAttributeName, getKimTypeService, getSequenceAccessorService, 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.kns.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toCopy, toString, toStringBuilder, toStringMapper, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow

Methods inherited from class java.lang.Object

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

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject

addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

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

members

private List<GroupDocumentMember> members

qualifiers

private List<GroupDocumentQualifier> qualifiers

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:

members - the members to set

getKimType

public KimTypeInfo getKimType()

Overrides:

getKimType in class IdentityManagementTypeAttributeTransactionalDocument

Returns:

the kimType

getBlankMember

public GroupDocumentMember getBlankMember()

Parameters:

members - the members to set

doRouteStatusChange

public void doRouteStatusChange(DocumentRouteStatusChangeDTO 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

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO)

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)

getQualifiersAsAttributeSet

public AttributeSet getQualifiersAsAttributeSet()

setDefinitions

public void setDefinitions(AttributeDefinitionMap definitions)

Overrides:

setDefinitions in class IdentityManagementTypeAttributeTransactionalDocument

isEditing

public boolean isEditing()

Returns:

the editing

setEditing

public void setEditing(boolean editing)

Parameters:

editing - the editing to set

setKimType

public void setKimType(KimTypeInfo kimType)

Overrides:

setKimType in class IdentityManagementTypeAttributeTransactionalDocument

Parameters:

kimType - the kimType to set