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

Class KualiDocumentFormBase

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
All Implemented Interfaces:
Serializable, PojoForm
Direct Known Subclasses:
KualiMaintenanceForm, KualiTransactionalDocumentFormBase
@Deprecated public abstract class KualiDocumentFormBase extends KualiForm implements Serializable
Deprecated.
Use DocumentFormBase.
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.
See Also:

  • Field Details

    • attachmentFile

      protected transient org.apache.struts.upload.FormFile attachmentFile
      Deprecated.

    • editingMode

      protected Map editingMode
      Deprecated.

    • documentActions

      protected Map documentActions
      Deprecated.

    • suppressAllButtons

      protected boolean suppressAllButtons
      Deprecated.

    • adHocActionRequestCodes

      protected Map adHocActionRequestCodes
      Deprecated.

  • Constructor Details

    • KualiDocumentFormBase

      public KualiDocumentFormBase()
      Deprecated.
      no args constructor that just initializes things for us

  • Method Details

    • addRequiredNonEditableProperties

      public void addRequiredNonEditableProperties()
      Deprecated.
      Description copied from interface: PojoForm
      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. Request parameter names corresponding to these properties will be populated into the form.
      Specified by:
      addRequiredNonEditableProperties in interface PojoForm
      Overrides:
      addRequiredNonEditableProperties in class KualiForm
      See Also:

    • getDocNum

      public String getDocNum()
      Deprecated.
      Returns:
      the docNum

    • setDocNum

      public void setDocNum(String docNum)
      Deprecated.
      Parameters:
      docNum - the docNum to set

    • populate

      public void populate(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Setup workflow doc in the document.
      Specified by:
      populate in interface PojoForm
      Overrides:
      populate in class KualiForm

    • getPersonInquiryUrlLink

      protected String getPersonInquiryUrlLink(org.kuali.rice.kim.api.identity.Person user, String linkBody)
      Deprecated.

    • getDocumentHandlerUrl

      protected String getDocumentHandlerUrl(String documentId)
      Deprecated.

    • buildHtmlLink

      protected String buildHtmlLink(String url, String linkBody)
      Deprecated.

    • populateHeaderFields

      public void populateHeaderFields(org.kuali.rice.kew.api.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.
      Parameters:
      workflowDocument - - the workflow document of the document being displayed (null is allowed)

    • getStandardHeaderFields

      protected List<HeaderField> getStandardHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
      Deprecated.
      This method returns a list of 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.
      Parameters:
      workflowDocument - - the workflow document of the document being displayed (null is allowed)
      Returns:
      a list of the standard fields displayed by default for all Kuali documents

    • validate

      public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Overrides:
      validate in class org.apache.struts.action.ActionForm
      See Also:
      • ActionForm.validate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)

    • isFormDocumentInitialized

      public final boolean isFormDocumentInitialized()
      Deprecated.
      Returns:
      true if this document was properly initialized with a DocumentHeader and related KualiWorkflowDocument

    • getEditingMode

      public Map getEditingMode()
      Deprecated.
      Returns:
      Map of editingModes for this document, as set during the most recent call to populate(javax.servlet.http.HttpServletRequest)

    • setEditingMode

      public void setEditingMode(Map editingMode)
      Deprecated.
      Set editingMode for this document

    • getDocumentActions

      public Map getDocumentActions()
      Deprecated.
      Returns:
      the documentActions

    • setDocumentActions

      public void setDocumentActions(Map documentActions)
      Deprecated.
      Parameters:
      documentActions - the documentActions to set

    • setAdHocActionRequestCodes

      public void setAdHocActionRequestCodes(Map adHocActionRequestCodes)
      Deprecated.
      Parameters:
      adHocActionRequestCodes - the adHocActionRequestCodes to set

    • getAdHocActionRequestCodes

      public Map getAdHocActionRequestCodes()
      Deprecated.
      Returns:
      a map of the possible action request codes that takes into account the users context on the document

    • getAdHocRoutePersons

      public List<org.kuali.rice.krad.bo.AdHocRoutePerson> getAdHocRoutePersons()
      Deprecated.
      Returns:
      the list of ad hoc routing persons

    • getAttachmentFile

      public org.apache.struts.upload.FormFile getAttachmentFile()
      Deprecated.
      Returns:
      attachmentFile

    • setAttachmentFile

      public void setAttachmentFile(org.apache.struts.upload.FormFile attachmentFile)
      Deprecated.
      Parameters:
      attachmentFile - The attachmentFile to set.

    • setAdHocRoutePersons

      public void setAdHocRoutePersons(List<org.kuali.rice.krad.bo.AdHocRoutePerson> adHocRouteRecipients)
      Deprecated.
      set the ad hoc routing persons list

    • getAdHocRouteWorkgroups

      public List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> getAdHocRouteWorkgroups()
      Deprecated.
      get the ad hoc routing workgroup requests

    • setAdHocRouteWorkgroups

      public void setAdHocRouteWorkgroups(List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> adHocRouteWorkgroups)
      Deprecated.
      set the ad hoc routing workgroup requests

    • getAdHocRoutePerson

      public org.kuali.rice.krad.bo.AdHocRoutePerson getAdHocRoutePerson(int index)
      Deprecated.
      Special getter based on index to work with multi rows for ad hoc routing to persons struts page

    • getAdHocRouteWorkgroup

      public org.kuali.rice.krad.bo.AdHocRouteWorkgroup getAdHocRouteWorkgroup(int index)
      Deprecated.
      Special getter based on index to work with multi rows for ad hoc routing to workgroups struts page

    • getNewAdHocRoutePerson

      public org.kuali.rice.krad.bo.AdHocRoutePerson getNewAdHocRoutePerson()
      Deprecated.
      Returns:
      the new ad hoc route person object

    • setNewAdHocRoutePerson

      public void setNewAdHocRoutePerson(org.kuali.rice.krad.bo.AdHocRoutePerson newAdHocRoutePerson)
      Deprecated.
      set the new ad hoc route person object

    • getNewAdHocRouteWorkgroup

      public org.kuali.rice.krad.bo.AdHocRouteWorkgroup getNewAdHocRouteWorkgroup()
      Deprecated.
      Returns:
      the new ad hoc route workgroup object

    • setNewAdHocRouteWorkgroup

      public void setNewAdHocRouteWorkgroup(org.kuali.rice.krad.bo.AdHocRouteWorkgroup newAdHocRouteWorkgroup)
      Deprecated.
      set the new ad hoc route workgroup object

    • getDocument

      public org.kuali.rice.krad.document.Document getDocument()
      Deprecated.
      Returns:
      Returns the Document

    • setDocument

      public void setDocument(org.kuali.rice.krad.document.Document document)
      Deprecated.

    • getWorkflowDocument

      public org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument()
      Deprecated.
      Returns:
      WorkflowDocument for this form's document

    • isHasWorkflowDocument

      public boolean isHasWorkflowDocument()
      Deprecated.
      Null-safe check to see if the workflow document object exists before attempting to retrieve it. (Which, if called, will throw an exception.)

    • isUserDocumentInitiator

      public boolean isUserDocumentInitiator()
      Deprecated.
      TODO rk implemented to account for caps coming from kuali user service from workflow

    • getInitiator

      public org.kuali.rice.kim.api.identity.Person getInitiator()
      Deprecated.

    • isDocumentEnRoute

      public boolean isDocumentEnRoute()
      Deprecated.
      Returns:
      true if the workflowDocument associated with this form is currently enroute

    • setAnnotation

      public void setAnnotation(String annotation)
      Deprecated.
      Parameters:
      annotation - The annotation to set.

    • getAnnotation

      public String getAnnotation()
      Deprecated.
      Returns:
      Returns the annotation.

    • getCommand

      public String getCommand()
      Deprecated.
      Returns:
      returns the command that was passed from workflow

    • setCommand

      public void setCommand(String command)
      Deprecated.
      setter for the command that was passed from workflow on the url

    • getDocId

      public String getDocId()
      Deprecated.
      Returns:
      returns the docId that was passed from workflow on the url

    • setDocId

      public void setDocId(String docId)
      Deprecated.
      setter for the docId that was passed from workflow on the url

    • getDocTypeName

      public String getDocTypeName()
      Deprecated.
      getter for the docTypeName that was passed from workflow on the url

    • setDocTypeName

      public void setDocTypeName(String docTypeName)
      Deprecated.
      setter for the docTypeName that was passed from workflow on the url

    • getInitiatorNetworkId

      public String getInitiatorNetworkId()
      Deprecated.
      getter for convenience that will return the initiators network id

    • isSuppressAllButtons

      public final boolean isSuppressAllButtons()
      Deprecated.
      Gets the suppressAllButtons attribute.
      Returns:
      Returns the suppressAllButtons.

    • setSuppressAllButtons

      public final void setSuppressAllButtons(boolean suppressAllButtons)
      Deprecated.
      Sets the suppressAllButtons attribute value.
      Parameters:
      suppressAllButtons - The suppressAllButtons to set.

    • hasDocumentId

      public boolean hasDocumentId()
      Deprecated.
      Returns:
      true if this form's getDocument() method returns a Document, and if that Document's getDocumentHeaderId method returns a non-null

    • setReturnToActionList

      public 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

    • isReturnToActionList

      public boolean isReturnToActionList()
      Deprecated.

    • getAdditionalScriptFiles

      public List<String> getAdditionalScriptFiles()
      Deprecated.

    • setAdditionalScriptFiles

      public void setAdditionalScriptFiles(List<String> additionalScriptFiles)
      Deprecated.

    • setAdditionalScriptFile

      public void setAdditionalScriptFile(int index, String scriptFile)
      Deprecated.

    • getAdditionalScriptFile

      public String getAdditionalScriptFile(int index)
      Deprecated.

    • getNewNote

      public org.kuali.rice.krad.bo.Note getNewNote()
      Deprecated.

    • setNewNote

      public void setNewNote(org.kuali.rice.krad.bo.Note newNote)
      Deprecated.

    • getBoNotes

      public List getBoNotes()
      Deprecated.
      Gets the boNotes attribute.
      Returns:
      Returns the boNotes.

    • setBoNotes

      public void setBoNotes(List boNotes)
      Deprecated.
      Sets the boNotes attribute value.
      Parameters:
      boNotes - The boNotes to set.

    • getFormKey

      public String getFormKey()
      Deprecated.

    • setFormKey

      public void setFormKey(String formKey)
      Deprecated.

    • reset

      public void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Overrides:
      reset in class KualiForm
      See Also:
      • ActionForm.reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)

    • customInitMaxUploadSizes

      protected void customInitMaxUploadSizes()
      Deprecated.
      Adds the attachment file size to the list of max file sizes.
      Overrides:
      customInitMaxUploadSizes in class PojoFormBase

    • shouldPropertyBePopulatedInForm

      public boolean shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      IMPORTANT: any overrides of this method must ensure that nothing in the HTTP request will be used to determine whether document is in session
      Specified by:
      shouldPropertyBePopulatedInForm in interface PojoForm
      Overrides:
      shouldPropertyBePopulatedInForm in class KualiForm
      Parameters:
      requestParameterName - the name of the request parameter
      request - the HTTP request
      Returns:
      whether the parameter should be
      See Also:

    • shouldMethodToCallParameterBeUsed

      public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Overrides:
      shouldMethodToCallParameterBeUsed in class KualiForm

    • getMessageMapFromPreviousRequest

      public org.kuali.rice.krad.util.MessageMap getMessageMapFromPreviousRequest()
      Deprecated.

    • setMessageMapFromPreviousRequest

      public void setMessageMapFromPreviousRequest(org.kuali.rice.krad.util.MessageMap errorMapFromPreviousRequest)
      Deprecated.

    • setDerivedValuesOnForm

      public void setDerivedValuesOnForm(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Overrides:
      setDerivedValuesOnForm in class KualiForm

    • getDefaultDocumentTypeName

      protected String getDefaultDocumentTypeName()
      Deprecated.

    • instantiateDocument

      protected void instantiateDocument()
      Deprecated.
      will instatiate a new document setting it on the form if getDefaultDocumentTypeName() is overridden to return a valid value.

    • initializeHeaderNavigationTabs

      protected void initializeHeaderNavigationTabs()
      Deprecated.
      initializes the header tabs from what is defined in the datadictionary if getDefaultDocumentTypeName() is overridden to return a valid value.

    • getActionRequests

      public List<org.kuali.rice.kew.api.action.ActionRequest> getActionRequests()
      Deprecated.

    • setActionRequests

      public void setActionRequests(List<org.kuali.rice.kew.api.action.ActionRequest> actionRequests)
      Deprecated.

    • getSelectedActionRequests

      public List<String> getSelectedActionRequests()
      Deprecated.

    • setSelectedActionRequests

      public void setSelectedActionRequests(List<String> selectedActionRequests)
      Deprecated.

    • getActionRequestsRequiringApproval

      public List<org.kuali.rice.kew.api.action.ActionRequest> getActionRequestsRequiringApproval()
      Deprecated.

    • getSuperUserAnnotation

      public String getSuperUserAnnotation()
      Deprecated.

    • setSuperUserAnnotation

      public void setSuperUserAnnotation(String superUserAnnotation)
      Deprecated.

    • isSuperUserActionAvaliable

      public boolean isSuperUserActionAvaliable()
      Deprecated.

    • isSuperUserApproveSingleActionRequestAuthorized

      public boolean isSuperUserApproveSingleActionRequestAuthorized()
      Deprecated.

    • isSuperUserApproveDocumentAuthorized

      public boolean isSuperUserApproveDocumentAuthorized()
      Deprecated.

    • isSuperUserDisapproveDocumentAuthorized

      public boolean isSuperUserDisapproveDocumentAuthorized()
      Deprecated.

    • isSuperUserAuthorized

      public boolean isSuperUserAuthorized()
      Deprecated.

    • isStateAllowsApproveOrDisapprove

      public boolean isStateAllowsApproveOrDisapprove()
      Deprecated.

    • isStateAllowsApproveSingleActionRequest

      public boolean isStateAllowsApproveSingleActionRequest()
      Deprecated.

    • isStateProcessedOrDisapproved

      public boolean isStateProcessedOrDisapproved(org.kuali.rice.kew.api.document.DocumentStatus status)
      Deprecated.

    • isStateInitiatedFinalCancelled

      public boolean isStateInitiatedFinalCancelled(org.kuali.rice.kew.api.document.DocumentStatus status)
      Deprecated.