org.kuali.rice.kim.document
Class IdentityManagementPersonDocument

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

All Implemented Interfaces:

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

@Entity
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 List<PersonDocumentAddress>	addrs
protected List<PersonDocumentAffiliation>	affiliations
protected String	campusCode
protected List<PersonDocumentCitizenship>	citizenships
protected DocumentHelperService	documentHelperService
protected List<PersonDocumentEmail>	emails
protected String	entityId
protected Map<String,String>	externalIdentifiers
protected List<PersonDocumentGroup>	groups
protected List<PersonDocumentName>	names
protected String	password
protected List<PersonDocumentPhone>	phones
protected String	principalId
protected String	principalName
protected PersonDocumentPrivacy	privacy
protected List<PersonDocumentRole>	roles
protected static long	serialVersionUID
protected UiDocumentService	uiDocumentService
protected String	univId

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

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

IdentityManagementPersonDocument()

Method Summary

List	buildListOfDeletionAwareLists() If this method is not implemented appropriately for PersistableBusinessObject with collections, then PersistableBusinessObject with collections will not persist deletions correctly.
void	doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) Handle the doRouteStatusChange event from the post processor
List<PersonDocumentAddress>	getAddrs()
List<PersonDocumentAffiliation>	getAffiliations()
String	getCampusCode()
List<PersonDocumentCitizenship>	getCitizenships()
protected DocumentHelperService	getDocumentHelperService()
List<PersonDocumentEmail>	getEmails()
String	getEntityId()
Map<String,String>	getExternalIdentifiers()
List<PersonDocumentGroup>	getGroups()
KimTypeAttributesHelper	getKimTypeAttributesHelper(String roleId)
List<PersonDocumentName>	getNames()
String	getPassword()
List<PersonDocumentPhone>	getPhones()
String	getPrincipalId()
String	getPrincipalName()
PersonDocumentPrivacy	getPrivacy()
List<PersonDocumentRole>	getRoles()
protected UiDocumentService	getUiDocumentService()
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(List<PersonDocumentAddress> addrs)
void	setAffiliations(List<PersonDocumentAffiliation> affiliations)
void	setCampusCode(String campusCode)
void	setCitizenships(List<PersonDocumentCitizenship> citizenships)
void	setEmails(List<PersonDocumentEmail> emails)
protected void	setEmployeeRecordIds()
void	setEntityId(String entityId)
void	setExternalIdentifiers(Map<String,String> externalIdentifiers)
void	setGroups(List<PersonDocumentGroup> groups)
void	setIfRolesEditable()
void	setNames(List<PersonDocumentName> names)
void	setPassword(String password)
void	setPhones(List<PersonDocumentPhone> phones)
void	setPrincipalId(String principalId)
void	setPrincipalName(String principalName)
void	setPrivacy(PersonDocumentPrivacy privacy)
void	setRoles(List<PersonDocumentRole> roles)
void	setUnivId(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.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addNote, addPessimisticLock, 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, 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, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, 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, 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

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

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

principalId

protected String principalId

principalName

protected String principalName

entityId

protected String entityId

password

protected String password

univId

protected String univId

affiliations

protected List<PersonDocumentAffiliation> affiliations

campusCode

protected String campusCode

externalIdentifiers

protected Map<String,String> externalIdentifiers

active

protected boolean active

citizenships

protected List<PersonDocumentCitizenship> citizenships

names

protected List<PersonDocumentName> names

addrs

protected List<PersonDocumentAddress> addrs

phones

protected List<PersonDocumentPhone> phones

emails

protected List<PersonDocumentEmail> emails

groups

protected List<PersonDocumentGroup> groups

roles

protected 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 String getPrincipalId()

setPrincipalId

public void setPrincipalId(String principalId)

getPrincipalName

public String getPrincipalName()

setPrincipalName

public void setPrincipalName(String principalName)

getEntityId

public String getEntityId()

setEntityId

public void setEntityId(String entityId)

getAffiliations

public List<PersonDocumentAffiliation> getAffiliations()

setAffiliations

public void setAffiliations(List<PersonDocumentAffiliation> affiliations)

getCampusCode

public String getCampusCode()

setCampusCode

public void setCampusCode(String campusCode)

getExternalIdentifiers

public Map<String,String> getExternalIdentifiers()

setExternalIdentifiers

public void setExternalIdentifiers(Map<String,String> externalIdentifiers)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getCitizenships

public List<PersonDocumentCitizenship> getCitizenships()

setCitizenships

public void setCitizenships(List<PersonDocumentCitizenship> citizenships)

getNames

public List<PersonDocumentName> getNames()

setNames

public void setNames(List<PersonDocumentName> names)

getAddrs

public List<PersonDocumentAddress> getAddrs()

setAddrs

public void setAddrs(List<PersonDocumentAddress> addrs)

getPhones

public List<PersonDocumentPhone> getPhones()

setPhones

public void setPhones(List<PersonDocumentPhone> phones)

getEmails

public List<PersonDocumentEmail> getEmails()

setEmails

public void setEmails(List<PersonDocumentEmail> emails)

setGroups

public void setGroups(List<PersonDocumentGroup> groups)

getRoles

public List<PersonDocumentRole> getRoles()

setRoles

public void setRoles(List<PersonDocumentRole> roles)

getGroups

public List<PersonDocumentGroup> getGroups()

getUnivId

public String getUnivId()

setUnivId

public void setUnivId(String univId)

getPrivacy

public PersonDocumentPrivacy getPrivacy()

setPrivacy

public void setPrivacy(PersonDocumentPrivacy privacy)

initializeDocumentForNewPerson

public void initializeDocumentForNewPerson()

buildListOfDeletionAwareLists

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

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

setIfRolesEditable

public void setIfRolesEditable()

validAssignRole

public boolean validAssignRole(PersonDocumentRole role)

getDocumentHelperService

protected DocumentHelperService getDocumentHelperService()

getUiDocumentService

protected UiDocumentService getUiDocumentService()