|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
DocumentFormBase
.
@Deprecated public abstract class KualiDocumentFormBase
TODO we should not be referencing kew constants from this class and wedding ourselves to that workflow application This class is the base action form for all documents.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm |
---|
KualiForm.TabState |
Field Summary | |
---|---|
protected Map |
adHocActionRequestCodes
Deprecated. |
protected org.apache.struts.upload.FormFile |
attachmentFile
Deprecated. |
protected Map |
documentActions
Deprecated. |
protected Map |
editingMode
Deprecated. |
protected boolean |
suppressAllButtons
Deprecated. |
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 | |
---|---|
KualiDocumentFormBase()
Deprecated. no args constructor that just initializes things for us |
Method Summary | |
---|---|
void |
addRequiredNonEditableProperties()
Deprecated. This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear. |
protected String |
buildHtmlLink(String url,
String linkBody)
Deprecated. |
protected void |
customInitMaxUploadSizes()
Deprecated. Adds the attachment file size to the list of max file sizes. |
List<ActionRequest> |
getActionRequests()
Deprecated. |
List<ActionRequest> |
getActionRequestsRequiringApproval()
Deprecated. |
String |
getAdditionalScriptFile(int index)
Deprecated. |
List<String> |
getAdditionalScriptFiles()
Deprecated. |
Map |
getAdHocActionRequestCodes()
Deprecated. |
AdHocRoutePerson |
getAdHocRoutePerson(int index)
Deprecated. Special getter based on index to work with multi rows for ad hoc routing to persons struts page |
List<AdHocRoutePerson> |
getAdHocRoutePersons()
Deprecated. |
AdHocRouteWorkgroup |
getAdHocRouteWorkgroup(int index)
Deprecated. Special getter based on index to work with multi rows for ad hoc routing to workgroups struts page |
List<AdHocRouteWorkgroup> |
getAdHocRouteWorkgroups()
Deprecated. get the ad hoc routing workgroup requests |
String |
getAnnotation()
Deprecated. |
org.apache.struts.upload.FormFile |
getAttachmentFile()
Deprecated. |
List |
getBoNotes()
Deprecated. Gets the boNotes attribute. |
String |
getCommand()
Deprecated. |
protected String |
getDefaultDocumentTypeName()
Deprecated. |
String |
getDocId()
Deprecated. |
String |
getDocNum()
Deprecated. |
String |
getDocTypeName()
Deprecated. getter for the docTypeName that was passed from workflow on the url |
Document |
getDocument()
Deprecated. |
Map |
getDocumentActions()
Deprecated. |
protected String |
getDocumentHandlerUrl(String documentId)
Deprecated. |
Map |
getEditingMode()
Deprecated. |
String |
getFormKey()
Deprecated. |
Person |
getInitiator()
Deprecated. |
String |
getInitiatorNetworkId()
Deprecated. getter for convenience that will return the initiators network id |
MessageMap |
getMessageMapFromPreviousRequest()
Deprecated. |
AdHocRoutePerson |
getNewAdHocRoutePerson()
Deprecated. |
AdHocRouteWorkgroup |
getNewAdHocRouteWorkgroup()
Deprecated. |
Note |
getNewNote()
Deprecated. |
protected String |
getPersonInquiryUrlLink(Person user,
String linkBody)
Deprecated. |
List<String> |
getSelectedActionRequests()
Deprecated. |
protected List<HeaderField> |
getStandardHeaderFields(WorkflowDocument workflowDocument)
Deprecated. This method returns a list of HeaderField objects that are used by default on Kuali document display pages. |
String |
getSuperUserAnnotation()
Deprecated. |
WorkflowDocument |
getWorkflowDocument()
Deprecated. |
boolean |
hasDocumentId()
Deprecated. |
protected void |
initializeHeaderNavigationTabs()
Deprecated. initializes the header tabs from what is defined in the datadictionary if getDefaultDocumentTypeName() is overriden to return a valid value. |
protected void |
instantiateDocument()
Deprecated. will instatiate a new document setting it on the form if getDefaultDocumentTypeName() is overriden to return a valid value. |
boolean |
isDocumentEnRoute()
Deprecated. |
boolean |
isFormDocumentInitialized()
Deprecated. |
boolean |
isHasWorkflowDocument()
Deprecated. Null-safe check to see if the workflow document object exists before attempting to retrieve it. |
boolean |
isReturnToActionList()
Deprecated. |
boolean |
isStateAllowsApproveOrDisapprove()
Deprecated. |
boolean |
isStateAllowsApproveSingleActionRequest()
Deprecated. |
boolean |
isStateInitiatedFinalCancelled(DocumentStatus status)
Deprecated. |
boolean |
isStateProcessedOrDisapproved(DocumentStatus status)
Deprecated. |
boolean |
isSuperUserActionAvaliable()
Deprecated. |
boolean |
isSuperUserApproveDocumentAuthorized()
Deprecated. |
boolean |
isSuperUserApproveSingleActionRequestAuthorized()
Deprecated. |
boolean |
isSuperUserAuthorized()
Deprecated. |
boolean |
isSuperUserDisapproveDocumentAuthorized()
Deprecated. |
boolean |
isSuppressAllButtons()
Deprecated. Gets the suppressAllButtons attribute. |
boolean |
isUserDocumentInitiator()
Deprecated. TODO rk implemented to account for caps coming from kuali user service from workflow |
void |
populate(javax.servlet.http.HttpServletRequest request)
Deprecated. Setup workflow doc in the document. |
void |
populateHeaderFields(WorkflowDocument workflowDocument)
Deprecated. This method is used to populate the list of header field objects (see KualiForm.getDocInfo() ) displayed on
the Kuali document form display pages. |
void |
reset(org.apache.struts.action.ActionMapping mapping,
javax.servlet.http.HttpServletRequest request)
Deprecated. |
void |
setActionRequests(List<ActionRequest> actionRequests)
Deprecated. |
void |
setAdditionalScriptFile(int index,
String scriptFile)
Deprecated. |
void |
setAdditionalScriptFiles(List<String> additionalScriptFiles)
Deprecated. |
void |
setAdHocActionRequestCodes(Map adHocActionRequestCodes)
Deprecated. |
void |
setAdHocRoutePersons(List<AdHocRoutePerson> adHocRouteRecipients)
Deprecated. set the ad hoc routing persons list |
void |
setAdHocRouteWorkgroups(List<AdHocRouteWorkgroup> adHocRouteWorkgroups)
Deprecated. set the ad hoc routing workgroup requests |
void |
setAnnotation(String annotation)
Deprecated. |
void |
setAttachmentFile(org.apache.struts.upload.FormFile attachmentFile)
Deprecated. |
void |
setBoNotes(List boNotes)
Deprecated. Sets the boNotes attribute value. |
void |
setCommand(String command)
Deprecated. setter for the command that was passed from workflow on the url |
void |
setDerivedValuesOnForm(javax.servlet.http.HttpServletRequest request)
Deprecated. |
void |
setDocId(String docId)
Deprecated. setter for the docId that was passed from workflow on the url |
void |
setDocNum(String docNum)
Deprecated. |
void |
setDocTypeName(String docTypeName)
Deprecated. setter for the docTypeName that was passed from workflow on the url |
void |
setDocument(Document document)
Deprecated. |
void |
setDocumentActions(Map documentActions)
Deprecated. |
void |
setEditingMode(Map editingMode)
Deprecated. Set editingMode for this document |
void |
setFormKey(String formKey)
Deprecated. |
void |
setMessageMapFromPreviousRequest(MessageMap errorMapFromPreviousRequest)
Deprecated. |
void |
setNewAdHocRoutePerson(AdHocRoutePerson newAdHocRoutePerson)
Deprecated. set the new ad hoc route person object |
void |
setNewAdHocRouteWorkgroup(AdHocRouteWorkgroup newAdHocRouteWorkgroup)
Deprecated. set the new ad hoc route workgroup object |
void |
setNewNote(Note newNote)
Deprecated. |
void |
setReturnToActionList(boolean returnToActionList)
Deprecated. Sets flag indicating whether upon completion of approve, blanketApprove, cancel, or disapprove, the user should be returned to the actionList instead of to the portal |
void |
setSelectedActionRequests(List<String> selectedActionRequests)
Deprecated. |
void |
setSuperUserAnnotation(String superUserAnnotation)
Deprecated. |
void |
setSuppressAllButtons(boolean suppressAllButtons)
Deprecated. Sets the suppressAllButtons attribute value. |
boolean |
shouldMethodToCallParameterBeUsed(String methodToCallParameterName,
String methodToCallParameterValue,
javax.servlet.http.HttpServletRequest request)
Deprecated. This overridden method ... |
boolean |
shouldPropertyBePopulatedInForm(String requestParameterName,
javax.servlet.http.HttpServletRequest request)
Deprecated. This overridden method ... |
org.apache.struts.action.ActionErrors |
validate(org.apache.struts.action.ActionMapping mapping,
javax.servlet.http.HttpServletRequest request)
Deprecated. |
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 Detail |
---|
protected org.apache.struts.upload.FormFile attachmentFile
protected Map editingMode
protected Map documentActions
protected boolean suppressAllButtons
protected Map adHocActionRequestCodes
Constructor Detail |
---|
public KualiDocumentFormBase()
Method Detail |
---|
public void addRequiredNonEditableProperties()
PojoForm
addRequiredNonEditableProperties
in interface PojoForm
addRequiredNonEditableProperties
in class KualiForm
KualiForm.addRequiredNonEditableProperties()
public String getDocNum()
public void setDocNum(String docNum)
docNum
- the docNum to setpublic void populate(javax.servlet.http.HttpServletRequest request)
populate
in interface PojoForm
populate
in class KualiForm
protected String getPersonInquiryUrlLink(Person user, String linkBody)
protected String getDocumentHandlerUrl(String documentId)
protected String buildHtmlLink(String url, String linkBody)
public void populateHeaderFields(WorkflowDocument workflowDocument)
KualiForm.getDocInfo()
) displayed on
the Kuali document form display pages.
workflowDocument
- - the workflow document of the document being displayed (null is allowed)protected List<HeaderField> getStandardHeaderFields(WorkflowDocument workflowDocument)
HeaderField
objects that are used by default on Kuali document display pages. To
use this list and override an individual HeaderField
object the id constants from
KRADConstants.DocumentFormHeaderFieldIds
can be used to identify items from the list.
workflowDocument
- - the workflow document of the document being displayed (null is allowed)
public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
validate
in class org.apache.struts.action.ActionForm
ActionForm.validate(org.apache.struts.action.ActionMapping,
javax.servlet.http.HttpServletRequest)
public final boolean isFormDocumentInitialized()
public Map getEditingMode()
public void setEditingMode(Map editingMode)
public Map getDocumentActions()
public void setDocumentActions(Map documentActions)
documentActions
- the documentActions to setpublic void setAdHocActionRequestCodes(Map adHocActionRequestCodes)
adHocActionRequestCodes
- the adHocActionRequestCodes to setpublic Map getAdHocActionRequestCodes()
public List<AdHocRoutePerson> getAdHocRoutePersons()
public org.apache.struts.upload.FormFile getAttachmentFile()
public void setAttachmentFile(org.apache.struts.upload.FormFile attachmentFile)
attachmentFile
- The attachmentFile to set.public void setAdHocRoutePersons(List<AdHocRoutePerson> adHocRouteRecipients)
adHocRouteRecipients
- public List<AdHocRouteWorkgroup> getAdHocRouteWorkgroups()
public void setAdHocRouteWorkgroups(List<AdHocRouteWorkgroup> adHocRouteWorkgroups)
adHocRouteWorkgroups
- public AdHocRoutePerson getAdHocRoutePerson(int index)
index
-
public AdHocRouteWorkgroup getAdHocRouteWorkgroup(int index)
index
-
public AdHocRoutePerson getNewAdHocRoutePerson()
public void setNewAdHocRoutePerson(AdHocRoutePerson newAdHocRoutePerson)
newAdHocRoutePerson
- public AdHocRouteWorkgroup getNewAdHocRouteWorkgroup()
public void setNewAdHocRouteWorkgroup(AdHocRouteWorkgroup newAdHocRouteWorkgroup)
newAdHocRouteWorkgroup
- public Document getDocument()
public void setDocument(Document document)
document
- public WorkflowDocument getWorkflowDocument()
public boolean isHasWorkflowDocument()
public boolean isUserDocumentInitiator()
public Person getInitiator()
public boolean isDocumentEnRoute()
public void setAnnotation(String annotation)
annotation
- The annotation to set.public String getAnnotation()
public String getCommand()
public void setCommand(String command)
command
- public String getDocId()
public void setDocId(String docId)
docId
- public String getDocTypeName()
public void setDocTypeName(String docTypeName)
docTypeName
- public String getInitiatorNetworkId()
public final boolean isSuppressAllButtons()
public final void setSuppressAllButtons(boolean suppressAllButtons)
suppressAllButtons
- The suppressAllButtons to set.public boolean hasDocumentId()
public void setReturnToActionList(boolean returnToActionList)
returnToActionList
- public boolean isReturnToActionList()
public List<String> getAdditionalScriptFiles()
public void setAdditionalScriptFiles(List<String> additionalScriptFiles)
public void setAdditionalScriptFile(int index, String scriptFile)
public String getAdditionalScriptFile(int index)
public Note getNewNote()
public void setNewNote(Note newNote)
public List getBoNotes()
public void setBoNotes(List boNotes)
boNotes
- The boNotes to set.public String getFormKey()
public void setFormKey(String formKey)
public void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
reset
in class KualiForm
ActionForm.reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)
protected void customInitMaxUploadSizes()
customInitMaxUploadSizes
in class PojoFormBase
org.kuali.rice.krad.web.struts.pojo.PojoFormBase#customInitMaxUploadSizes()
public boolean shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request)
shouldPropertyBePopulatedInForm
in interface PojoForm
shouldPropertyBePopulatedInForm
in class KualiForm
requestParameterName
- the name of the request parameterrequest
- the HTTP request
org.kuali.rice.krad.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)
public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request)
shouldMethodToCallParameterBeUsed
in class KualiForm
KualiForm.shouldMethodToCallParameterBeUsed(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)
public MessageMap getMessageMapFromPreviousRequest()
public void setMessageMapFromPreviousRequest(MessageMap errorMapFromPreviousRequest)
public void setDerivedValuesOnForm(javax.servlet.http.HttpServletRequest request)
setDerivedValuesOnForm
in class KualiForm
protected String getDefaultDocumentTypeName()
protected void instantiateDocument()
getDefaultDocumentTypeName()
is overriden to return a valid value.
protected void initializeHeaderNavigationTabs()
getDefaultDocumentTypeName()
is overriden to return a valid value.
public List<ActionRequest> getActionRequests()
public void setActionRequests(List<ActionRequest> actionRequests)
public List<String> getSelectedActionRequests()
public void setSelectedActionRequests(List<String> selectedActionRequests)
public List<ActionRequest> getActionRequestsRequiringApproval()
public String getSuperUserAnnotation()
public void setSuperUserAnnotation(String superUserAnnotation)
public boolean isSuperUserActionAvaliable()
public boolean isSuperUserApproveSingleActionRequestAuthorized()
public boolean isSuperUserApproveDocumentAuthorized()
public boolean isSuperUserDisapproveDocumentAuthorized()
public boolean isSuperUserAuthorized()
public boolean isStateAllowsApproveOrDisapprove()
public boolean isStateAllowsApproveSingleActionRequest()
public boolean isStateProcessedOrDisapproved(DocumentStatus status)
public boolean isStateInitiatedFinalCancelled(DocumentStatus status)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |