org.kuali.rice.kim.document
Class IdentityManagementPersonDocument

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.IdentityManagementPersonDocument

All Implemented Interfaces:

java.io.Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, PersistableBusinessObject, Document, SessionDocument, TransactionalDocument

public class IdentityManagementPersonDocument
extends IdentityManagementKimDocument

This is a description of what this class does - shyu 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 java.util.List<PersonDocumentAddress>	addrs
protected java.util.List<PersonDocumentAffiliation>	affiliations
protected java.lang.String	campusCode
protected java.util.List<PersonDocumentCitizenship>	citizenships
protected DocumentHelperService	documentHelperService
protected java.util.List<PersonDocumentEmail>	emails
protected java.lang.String	entityId
protected java.util.Map<java.lang.String,java.lang.String>	externalIdentifiers
protected java.util.List<PersonDocumentGroup>	groups
protected java.util.List<PersonDocumentName>	names
protected java.lang.String	password
protected java.util.List<PersonDocumentPhone>	phones
protected java.lang.String	principalId
protected java.lang.String	principalName
protected PersonDocumentPrivacy	privacy
protected java.util.List<PersonDocumentRole>	roles
protected static long	serialVersionUID
protected UiDocumentService	uiDocumentService
protected java.lang.String	univId

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

delegationMembers, delegations, LOG, 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

IdentityManagementPersonDocument()

Method Summary

java.util.List	buildListOfDeletionAwareLists() If this method is not implemented appropriately for PersistableBusinessObject with collections, then PersistableBusinessObject with collections will not persist deletions correctly.
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) Handle the doRouteStatusChange event from the post processor
java.util.List<PersonDocumentAddress>	getAddrs()
java.util.List<PersonDocumentAffiliation>	getAffiliations()
java.lang.String	getCampusCode()
java.util.List<PersonDocumentCitizenship>	getCitizenships()
protected DocumentHelperService	getDocumentHelperService()
java.util.List<PersonDocumentEmail>	getEmails()
java.lang.String	getEntityId()
java.util.Map<java.lang.String,java.lang.String>	getExternalIdentifiers()
java.util.List<PersonDocumentGroup>	getGroups()
KimTypeAttributesHelper	getKimTypeAttributesHelper(java.lang.String roleId)
java.util.List<PersonDocumentName>	getNames()
java.lang.String	getPassword()
java.util.List<PersonDocumentPhone>	getPhones()
java.lang.String	getPrincipalId()
java.lang.String	getPrincipalName()
PersonDocumentPrivacy	getPrivacy()
java.util.List<PersonDocumentRole>	getRoles()
protected UiDocumentService	getUiDocumentService()
java.lang.String	getUnivId()
void	initializeDocumentForNewPerson()
boolean	isActive()
void	prepareForSave() This method provides a hook that will be called before the document is saved.
void	setActive(boolean active)
void	setAddrs(java.util.List<PersonDocumentAddress> addrs)
void	setAffiliations(java.util.List<PersonDocumentAffiliation> affiliations)
void	setCampusCode(java.lang.String campusCode)
void	setCitizenships(java.util.List<PersonDocumentCitizenship> citizenships)
void	setEmails(java.util.List<PersonDocumentEmail> emails)
protected void	setEmployeeRecordIds()
void	setEntityId(java.lang.String entityId)
void	setExternalIdentifiers(java.util.Map<java.lang.String,java.lang.String> externalIdentifiers)
void	setGroups(java.util.List<PersonDocumentGroup> groups)
void	setIfRolesEditable()
void	setNames(java.util.List<PersonDocumentName> names)
void	setPassword(java.lang.String password)
void	setPhones(java.util.List<PersonDocumentPhone> phones)
void	setPrincipalId(java.lang.String principalId)
void	setPrincipalName(java.lang.String principalName)
void	setPrivacy(PersonDocumentPrivacy privacy)
void	setRoles(java.util.List<PersonDocumentRole> roles)
void	setUnivId(java.lang.String univId)
boolean	validAssignRole(PersonDocumentRole role)

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

addDelegationMemberToDelegation, getDelegationId, getDelegationMembers, getDelegations, getKimAttributeDefnId, getPrimaryDelegation, getSecondaryDelegation, getSequenceAccessorService, 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, 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, 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

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

principalId

protected java.lang.String principalId

principalName

protected java.lang.String principalName

entityId

protected java.lang.String entityId

password

protected java.lang.String password

univId

protected java.lang.String univId

affiliations

protected java.util.List<PersonDocumentAffiliation> affiliations

campusCode

protected java.lang.String campusCode

externalIdentifiers

protected java.util.Map<java.lang.String,java.lang.String> externalIdentifiers

active

protected boolean active

citizenships

protected java.util.List<PersonDocumentCitizenship> citizenships

names

protected java.util.List<PersonDocumentName> names

addrs

protected java.util.List<PersonDocumentAddress> addrs

phones

protected java.util.List<PersonDocumentPhone> phones

emails

protected java.util.List<PersonDocumentEmail> emails

groups

protected java.util.List<PersonDocumentGroup> groups

roles

protected java.util.List<PersonDocumentRole> roles

privacy

protected PersonDocumentPrivacy privacy

documentHelperService

protected transient DocumentHelperService documentHelperService

uiDocumentService

protected transient UiDocumentService uiDocumentService

Constructor Detail

IdentityManagementPersonDocument

public IdentityManagementPersonDocument()

Method Detail

getPrincipalId

public java.lang.String getPrincipalId()

setPrincipalId

public void setPrincipalId(java.lang.String principalId)

getPrincipalName

public java.lang.String getPrincipalName()

setPrincipalName

public void setPrincipalName(java.lang.String principalName)

getEntityId

public java.lang.String getEntityId()

setEntityId

public void setEntityId(java.lang.String entityId)

getAffiliations

public java.util.List<PersonDocumentAffiliation> getAffiliations()

setAffiliations

public void setAffiliations(java.util.List<PersonDocumentAffiliation> affiliations)

getCampusCode

public java.lang.String getCampusCode()

setCampusCode

public void setCampusCode(java.lang.String campusCode)

getExternalIdentifiers

public java.util.Map<java.lang.String,java.lang.String> getExternalIdentifiers()

setExternalIdentifiers

public void setExternalIdentifiers(java.util.Map<java.lang.String,java.lang.String> externalIdentifiers)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getCitizenships

public java.util.List<PersonDocumentCitizenship> getCitizenships()

setCitizenships

public void setCitizenships(java.util.List<PersonDocumentCitizenship> citizenships)

getNames

public java.util.List<PersonDocumentName> getNames()

setNames

public void setNames(java.util.List<PersonDocumentName> names)

getAddrs

public java.util.List<PersonDocumentAddress> getAddrs()

setAddrs

public void setAddrs(java.util.List<PersonDocumentAddress> addrs)

getPhones

public java.util.List<PersonDocumentPhone> getPhones()

setPhones

public void setPhones(java.util.List<PersonDocumentPhone> phones)

getEmails

public java.util.List<PersonDocumentEmail> getEmails()

setEmails

public void setEmails(java.util.List<PersonDocumentEmail> emails)

setGroups

public void setGroups(java.util.List<PersonDocumentGroup> groups)

getRoles

public java.util.List<PersonDocumentRole> getRoles()

setRoles

public void setRoles(java.util.List<PersonDocumentRole> roles)

getGroups

public java.util.List<PersonDocumentGroup> getGroups()

getUnivId

public java.lang.String getUnivId()

setUnivId

public void setUnivId(java.lang.String univId)

getPrivacy

public PersonDocumentPrivacy getPrivacy()

setPrivacy

public void setPrivacy(PersonDocumentPrivacy privacy)

initializeDocumentForNewPerson

public void initializeDocumentForNewPerson()

buildListOfDeletionAwareLists

public java.util.List buildListOfDeletionAwareLists()

Description copied from interface: PersistableBusinessObject

If this method is not implemented appropriately for PersistableBusinessObject with collections, then PersistableBusinessObject with collections will not persist deletions correctly. Elements that have been deleted will reappear in the DB after retrieval.

Specified by:

buildListOfDeletionAwareLists in interface PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class PersistableBusinessObjectBase

Returns:

List of collections which need to be monitored for changes by OJB

See Also:

PersistableBusinessObject.buildListOfDeletionAwareLists()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.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()

setEmployeeRecordIds

protected void setEmployeeRecordIds()

getKimTypeAttributesHelper

public KimTypeAttributesHelper getKimTypeAttributesHelper(java.lang.String roleId)

setIfRolesEditable

public void setIfRolesEditable()

validAssignRole

public boolean validAssignRole(PersonDocumentRole role)

getDocumentHelperService

protected DocumentHelperService getDocumentHelperService()

getUiDocumentService

protected UiDocumentService getUiDocumentService()