org.kuali.rice.kim.document
Class IdentityManagementRoleDocument

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          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.IdentityManagementRoleDocument

All Implemented Interfaces:

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

public class IdentityManagementRoleDocument
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

Nested Class Summary

static class

IdentityManagementRoleDocument.RoleMemberMetaDataType

Field Summary

protected boolean	active
protected boolean	editing
protected IdentityManagementRoleDocument.RoleMemberMetaDataType	memberMetaDataType
protected List<KimDocumentRoleMember>	members
protected List<KimDocumentRoleMember>	modifiedMembers
protected List<KimDocumentRolePermission>	permissions
protected List<KimDocumentRoleResponsibility>	responsibilities
protected String	roleDescription
protected String	roleId
protected String	roleName
protected String	roleNamespace
protected String	roleTypeId
protected String	roleTypeName
protected List<KimDocumentRoleMember>	searchResultMembers

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

LOG, sequenceAccessorService

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

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

IdentityManagementRoleDocument()

Method Summary

void	addDelegationMember(RoleDocumentDelegationMember newDelegationMember)
void	addMember(KimDocumentRoleMember member)
void	addResponsibility(KimDocumentRoleResponsibility roleResponsibility)
void	doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) Handle the doRouteStatusChange event from the post processor
RoleDocumentDelegationMember	getBlankDelegationMember()
KimDocumentRoleMember	getBlankMember()
List<RoleDocumentDelegationMember>	getDelegationMembers()
List<RoleDocumentDelegation>	getDelegations()
KimDocumentRoleMember	getMember(String roleMemberId)
IdentityManagementRoleDocument.RoleMemberMetaDataType	getMemberMetaDataType()
List<KimDocumentRoleMember>	getMembers()
List<KimDocumentRoleMember>	getModifiedMembers()
protected KimDocumentRoleResponsibilityAction	getNewRespAction(KimDocumentRoleResponsibility roleResponsibility)
List<KimDocumentRolePermission>	getPermissions()
List<KimDocumentRoleResponsibility>	getResponsibilities()
ResponsibilityInternalService	getResponsibilityInternalService()
ResponsibilityService	getResponsibilityService()
String	getRoleDescription()
String	getRoleId()
String	getRoleName()
String	getRoleNamespace()
String	getRoleTypeId()
String	getRoleTypeName()
List<KimDocumentRoleMember>	getSearchResultMembers()
void	initializeDocumentForNewRole()
boolean	isActive()
boolean	isEditing()
void	prepareForSave() This method provides a hook that will be called before the document is saved.
void	setActive(boolean active)
protected void	setAttrDefnIdForDelMemberQualifier(RoleDocumentDelegationMemberQualifier qualifier, KimAttributeField definition)
void	setDelegationMembers(List<RoleDocumentDelegationMember> delegationMembers)
void	setDelegations(List<RoleDocumentDelegation> delegations)
void	setEditing(boolean editing)
void	setKimType(KimType kimType)
void	setMemberMetaDataType(IdentityManagementRoleDocument.RoleMemberMetaDataType memberMetaDataType)
void	setMemberMetaDataTypeToSort(Integer columnNumber)
void	setMembers(List<KimDocumentRoleMember> members)
void	setModifiedMembers(List<KimDocumentRoleMember> modifiedMembers)
void	setPermissions(List<KimDocumentRolePermission> permissions)
void	setResponsibilities(List<KimDocumentRoleResponsibility> responsibilities)
void	setRoleDescription(String roleDescription)
void	setRoleId(String roleId)
void	setRoleName(String roleName)
void	setRoleNamespace(String roleNamespace)
void	setRoleTypeId(String roleTypeId)
void	setRoleTypeName(String roleTypeName)
void	setSearchResultMembers(List<KimDocumentRoleMember> searchResultMembers)
void	setupMemberRspActions(KimDocumentRoleMember member)
void	setupMemberRspActions(KimDocumentRoleResponsibility roleResp, KimDocumentRoleMember member)
void	updateMembers(IdentityManagementRoleDocumentForm roleDocumentForm)
void	updateMembers(KimDocumentRoleResponsibility newResponsibility)

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

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

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

addDelegationMemberToDelegation, getDelegationId, getKimAttributeDefnId, getPrimaryDelegation, getSecondaryDelegation, getSequenceAccessorService

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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, processAfterRetrieve, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, toCopy, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

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

getVersionNumber

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

getObjectId

Field Detail

roleId

protected String roleId

roleTypeId

protected String roleTypeId

roleTypeName

protected String roleTypeName

roleNamespace

protected String roleNamespace

roleName

protected String roleName

roleDescription

protected String roleDescription

active

protected boolean active

editing

protected boolean editing

permissions

protected List<KimDocumentRolePermission> permissions

responsibilities

protected List<KimDocumentRoleResponsibility> responsibilities

modifiedMembers

protected List<KimDocumentRoleMember> modifiedMembers

searchResultMembers

protected List<KimDocumentRoleMember> searchResultMembers

members

protected List<KimDocumentRoleMember> members

memberMetaDataType

protected IdentityManagementRoleDocument.RoleMemberMetaDataType memberMetaDataType

Constructor Detail

IdentityManagementRoleDocument

public IdentityManagementRoleDocument()

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 roleId)

Parameters:

roleId - the roleId to set

getRoleName

public String getRoleName()

Returns:

the roleName

setRoleName

public void setRoleName(String roleName)

Parameters:

roleName - the roleName to set

getRoleDescription

public String getRoleDescription()

Returns:

the roleDescription

setRoleDescription

public void setRoleDescription(String roleDescription)

Parameters:

roleDescription - the roleDescription to set

getRoleNamespace

public String getRoleNamespace()

Returns:

the roleNamespace

setRoleNamespace

public void setRoleNamespace(String roleNamespace)

Parameters:

roleNamespace - the roleNamespace to set

getRoleTypeId

public String getRoleTypeId()

Returns:

the roleTypeId

setRoleTypeId

public void setRoleTypeId(String roleTypeId)

Parameters:

roleTypeId - the roleTypeId to set

getRoleTypeName

public String getRoleTypeName()

Returns:

the roleTypeName

setRoleTypeName

public void setRoleTypeName(String roleTypeName)

Parameters:

roleTypeName - the roleTypeName to set

getDelegationMembers

public List<RoleDocumentDelegationMember> getDelegationMembers()

Overrides:

getDelegationMembers in class IdentityManagementKimDocument

Returns:

the delegationMembers

setDelegationMembers

public void setDelegationMembers(List<RoleDocumentDelegationMember> delegationMembers)

Overrides:

setDelegationMembers in class IdentityManagementKimDocument

Parameters:

delegationMembers - the delegationMembers to set

getPermissions

public List<KimDocumentRolePermission> getPermissions()

Returns:

the permissions

setPermissions

public void setPermissions(List<KimDocumentRolePermission> permissions)

Parameters:

permissions - the permissions to set

getResponsibilities

public List<KimDocumentRoleResponsibility> getResponsibilities()

Returns:

the responsibilities

setResponsibilities

public void setResponsibilities(List<KimDocumentRoleResponsibility> responsibilities)

Parameters:

responsibilities - the responsibilities to set

getMembers

public List<KimDocumentRoleMember> getMembers()

Returns:

the members

setMemberMetaDataTypeToSort

public void setMemberMetaDataTypeToSort(Integer columnNumber)

getMemberMetaDataType

public IdentityManagementRoleDocument.RoleMemberMetaDataType getMemberMetaDataType()

setMemberMetaDataType

public void setMemberMetaDataType(IdentityManagementRoleDocument.RoleMemberMetaDataType memberMetaDataType)

getMember

public KimDocumentRoleMember getMember(String roleMemberId)

Returns:

the members

setMembers

public void setMembers(List<KimDocumentRoleMember> members)

Parameters:

members - the members to set

getModifiedMembers

public List<KimDocumentRoleMember> getModifiedMembers()

Returns:

the modifiedMembers

setModifiedMembers

public void setModifiedMembers(List<KimDocumentRoleMember> modifiedMembers)

Parameters:

modifiedMembers - the modifiedMembers to set

getSearchResultMembers

public List<KimDocumentRoleMember> getSearchResultMembers()

Returns:

the searchResultMembers

setSearchResultMembers

public void setSearchResultMembers(List<KimDocumentRoleMember> searchResultMembers)

Parameters:

searchResultMembers - the searchResultMembers to set

addResponsibility

public void addResponsibility(KimDocumentRoleResponsibility roleResponsibility)

getNewRespAction

protected KimDocumentRoleResponsibilityAction getNewRespAction(KimDocumentRoleResponsibility roleResponsibility)

addDelegationMember

public void addDelegationMember(RoleDocumentDelegationMember newDelegationMember)

addMember

public void addMember(KimDocumentRoleMember member)

Parameters:

member - the members to set

getBlankMember

public KimDocumentRoleMember getBlankMember()

getBlankDelegationMember

public RoleDocumentDelegationMember getBlankDelegationMember()

setupMemberRspActions

public void setupMemberRspActions(KimDocumentRoleMember member)

updateMembers

public void updateMembers(IdentityManagementRoleDocumentForm roleDocumentForm)

updateMembers

public void updateMembers(KimDocumentRoleResponsibility newResponsibility)

setupMemberRspActions

public void setupMemberRspActions(KimDocumentRoleResponsibility roleResp,
                                  KimDocumentRoleMember member)

setAttrDefnIdForDelMemberQualifier

protected void setAttrDefnIdForDelMemberQualifier(RoleDocumentDelegationMemberQualifier qualifier,
                                                  KimAttributeField definition)

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

See Also:

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

initializeDocumentForNewRole

public void initializeDocumentForNewRole()

getRoleId

public String getRoleId()

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()

getResponsibilityService

public ResponsibilityService getResponsibilityService()

getResponsibilityInternalService

public ResponsibilityInternalService getResponsibilityInternalService()

isEditing

public boolean isEditing()

Returns:

the editing

setEditing

public void setEditing(boolean editing)

Parameters:

editing - the editing to set

getDelegations

public List<RoleDocumentDelegation> getDelegations()

Overrides:

getDelegations in class IdentityManagementKimDocument

Returns:

the delegations

setDelegations

public void setDelegations(List<RoleDocumentDelegation> delegations)

Overrides:

setDelegations in class IdentityManagementKimDocument

Parameters:

delegations - the delegations to set

setKimType

public void setKimType(KimType kimType)

Overrides:

setKimType in class IdentityManagementTypeAttributeTransactionalDocument

Parameters:

kimType - the kimType to set