Package org.kuali.rice.kim.web.struts.form

Class IdentityManagementPersonDocumentForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

org.kuali.rice.kim.web.struts.form.IdentityManagementDocumentFormBase

org.kuali.rice.kim.web.struts.form.IdentityManagementPersonDocumentForm

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

public class IdentityManagementPersonDocumentForm
extends IdentityManagementDocumentFormBase

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiForm.TabState

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	canModifyEntity
protected boolean	canOverrideEntityPrivacyPreferences
protected boolean	delegationMemberLookup
protected PersonDocumentAddress	newAddress
protected PersonDocumentAffiliation	newAffln
protected PersonDocumentCitizenship	newCitizenship
protected RoleDocumentDelegationMember	newDelegationMember
protected String	newDelegationMemberRoleId
protected PersonDocumentEmail	newEmail
protected PersonDocumentEmploymentInfo	newEmpInfo
protected PersonDocumentGroup	newGroup
protected PersonDocumentName	newName
protected PersonDocumentPhone	newPhone
protected PersonDocumentRole	newRole
protected String	principalId
protected static final long	serialVersionUID
protected boolean	userSameAsPersonEdited

Fields inherited from class org.kuali.rice.kim.web.struts.form.IdentityManagementDocumentFormBase

CHANGE_DEL_ROLE_MEMBER_METHOD_TO_CALL, CHANGE_MEMBER_TYPE_CODE_METHOD_TO_CALL, CHANGE_NAMESPACE_METHOD_TO_CALL, inquiry, LOG, MAX_MEMBERS_PER_PAGE_PARM, memberTableMetadata, recordsPerPage

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor	Description
IdentityManagementPersonDocumentForm()

Method Summary

Modifier and Type	Method	Description
String	getDefaultDocumentTypeName()
PersonDocumentAddress	getNewAddress()
PersonDocumentAffiliation	getNewAffln()
PersonDocumentCitizenship	getNewCitizenship()
RoleDocumentDelegationMember	getNewDelegationMember()
String	getNewDelegationMemberRoleId()
PersonDocumentEmail	getNewEmail()
PersonDocumentEmploymentInfo	getNewEmpInfo()
PersonDocumentGroup	getNewGroup()
PersonDocumentName	getNewName()
PersonDocumentPhone	getNewPhone()
PersonDocumentRole	getNewRole()
IdentityManagementPersonDocument	getPersonDocument()
String	getPrincipalId()
boolean	isCanModifyEntity()
boolean	isCanOverrideEntityPrivacyPreferences()
boolean	isDelegationMemberLookup()
boolean	isPrincipalIdEditable()	Check whether principal id is editable.
boolean	isUserSameAsPersonEdited()
void	setCanModifyEntity(boolean canModifyEntity)
void	setCanOverrideEntityPrivacyPreferences(boolean canOverrideEntityPrivacyPreferences)
void	setDelegationMemberLookup(boolean delegationMemberLookup)
void	setNewAddress(PersonDocumentAddress newAddress)
void	setNewAffln(PersonDocumentAffiliation newAffln)
void	setNewCitizenship(PersonDocumentCitizenship newCitizenship)
void	setNewDelegationMember(RoleDocumentDelegationMember newDelegationMember)
void	setNewDelegationMemberRoleId(String newDelegationMemberRoleId)
void	setNewEmail(PersonDocumentEmail newEmail)
void	setNewEmpInfo(PersonDocumentEmploymentInfo newEmpInfo)
void	setNewGroup(PersonDocumentGroup newGroup)
void	setNewName(PersonDocumentName newName)
void	setNewPhone(PersonDocumentPhone newPhone)
void	setNewRole(PersonDocumentRole newRole)
void	setPrincipalId(String principalId)
void	setUserSameAsPersonEdited(boolean userSameAsPersonEdited)

Methods inherited from class org.kuali.rice.kim.web.struts.form.IdentityManagementDocumentFormBase

getMemberRows, getMemberTableMetadata, getRecordsPerPage, isCanExport, isInquiry, populate, setInquiry, setMemberTableMetadata

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, populateHeaderFields, reset, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

protected static final long serialVersionUID

See Also:

• Constant Field Values

principalId

protected String principalId

newAffln

protected PersonDocumentAffiliation newAffln

newEmpInfo

protected PersonDocumentEmploymentInfo newEmpInfo

newCitizenship

protected PersonDocumentCitizenship newCitizenship

newName

protected PersonDocumentName newName

newAddress

protected PersonDocumentAddress newAddress

newPhone

protected PersonDocumentPhone newPhone

newEmail

protected PersonDocumentEmail newEmail

newGroup

protected PersonDocumentGroup newGroup

newRole

protected PersonDocumentRole newRole

newDelegationMember

protected RoleDocumentDelegationMember newDelegationMember

newDelegationMemberRoleId

protected String newDelegationMemberRoleId

delegationMemberLookup

protected boolean delegationMemberLookup

canModifyEntity

protected boolean canModifyEntity

canOverrideEntityPrivacyPreferences

protected boolean canOverrideEntityPrivacyPreferences

userSameAsPersonEdited

protected boolean userSameAsPersonEdited

Constructor Details

IdentityManagementPersonDocumentForm

public IdentityManagementPersonDocumentForm()

Method Details

isCanModifyEntity

public boolean isCanModifyEntity()

Returns:

the canModifyEntity

setCanModifyEntity

public void setCanModifyEntity(boolean canModifyEntity)

Parameters:

canModifyEntity - the canModifyEntity to set

getDefaultDocumentTypeName

public String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

getPersonDocument

public IdentityManagementPersonDocument getPersonDocument()

getNewAffln

public PersonDocumentAffiliation getNewAffln()

setNewAffln

public void setNewAffln(PersonDocumentAffiliation newAffln)

getNewEmpInfo

public PersonDocumentEmploymentInfo getNewEmpInfo()

setNewEmpInfo

public void setNewEmpInfo(PersonDocumentEmploymentInfo newEmpInfo)

getNewCitizenship

public PersonDocumentCitizenship getNewCitizenship()

setNewCitizenship

public void setNewCitizenship(PersonDocumentCitizenship newCitizenship)

getNewName

public PersonDocumentName getNewName()

setNewName

public void setNewName(PersonDocumentName newName)

getNewAddress

public PersonDocumentAddress getNewAddress()

setNewAddress

public void setNewAddress(PersonDocumentAddress newAddress)

getNewPhone

public PersonDocumentPhone getNewPhone()

setNewPhone

public void setNewPhone(PersonDocumentPhone newPhone)

getNewEmail

public PersonDocumentEmail getNewEmail()

setNewEmail

public void setNewEmail(PersonDocumentEmail newEmail)

getNewGroup

public PersonDocumentGroup getNewGroup()

setNewGroup

public void setNewGroup(PersonDocumentGroup newGroup)

getNewRole

public PersonDocumentRole getNewRole()

setNewRole

public void setNewRole(PersonDocumentRole newRole)

getPrincipalId

public String getPrincipalId()

setPrincipalId

public void setPrincipalId(String principalId)

getNewDelegationMember

public RoleDocumentDelegationMember getNewDelegationMember()

Returns:

the newDelegationMember

setNewDelegationMember

public void setNewDelegationMember(RoleDocumentDelegationMember newDelegationMember)

Parameters:

newDelegationMember - the newDelegationMember to set

isDelegationMemberLookup

public boolean isDelegationMemberLookup()

Returns:

the delegationMemberLookup

setDelegationMemberLookup

public void setDelegationMemberLookup(boolean delegationMemberLookup)

Parameters:

delegationMemberLookup - the delegationMemberLookup to set

getNewDelegationMemberRoleId

public String getNewDelegationMemberRoleId()

Returns:

the newDelegationMemberRoleId

setNewDelegationMemberRoleId

public void setNewDelegationMemberRoleId(String newDelegationMemberRoleId)

Parameters:

newDelegationMemberRoleId - the newDelegationMemberRoleId to set

isCanOverrideEntityPrivacyPreferences

public boolean isCanOverrideEntityPrivacyPreferences()

Returns:

the canOverrideEntityPrivacyPreferences

setCanOverrideEntityPrivacyPreferences

public void setCanOverrideEntityPrivacyPreferences(boolean canOverrideEntityPrivacyPreferences)

Parameters:

canOverrideEntityPrivacyPreferences - the canOverrideEntityPrivacyPreferences to set

isUserSameAsPersonEdited

public boolean isUserSameAsPersonEdited()

Returns:

the userSameAsPersonEdited

setUserSameAsPersonEdited

public void setUserSameAsPersonEdited(boolean userSameAsPersonEdited)

Parameters:

userSameAsPersonEdited - the userSameAsPersonEdited to set

isPrincipalIdEditable

public boolean isPrincipalIdEditable()

Check whether principal id is editable. Verify auto generated parameter. Principal Id is not editable while editing existing document