Package org.kuali.rice.kew.api.document

Interface DocumentContract

All Known Subinterfaces:
WorkflowDocument
All Known Implementing Classes:
Document, Document.Builder
public interface DocumentContract
Provides read-only access to Document meta-data.

  • Method Details

    • getDocumentId

      String getDocumentId()
      Retrieve the document id
      Returns:
      the document id

    • getStatus

      DocumentStatus getStatus()
      Retrieve the document status
      Returns:
      the document status

    • getDateCreated

      org.joda.time.DateTime getDateCreated()
      Retrieve the document creation date
      Returns:
      the document creation date or null

    • getDateLastModified

      org.joda.time.DateTime getDateLastModified()
      Retrieve the document last-modified date
      Returns:
      the document last-modified date or null

    • getDateApproved

      org.joda.time.DateTime getDateApproved()
      Retrieve the document approval date
      Returns:
      the document approval date or null

    • getDateFinalized

      org.joda.time.DateTime getDateFinalized()
      Retrieve the document finalization date
      Returns:
      the document finalization date or null

    • getTitle

      String getTitle()
      Retrieve the document title
      Returns:
      the document title

    • getApplicationDocumentId

      String getApplicationDocumentId()
      Retrieve the application document id. The Application Document Id is used to record an application-relevant id for the workflow document.
      Returns:
      the application document id

    • getInitiatorPrincipalId

      String getInitiatorPrincipalId()
      Retrieve the initiator principal id
      Returns:
      the initiator principal id

    • getRoutedByPrincipalId

      String getRoutedByPrincipalId()
      Retrieve the router principal id
      Returns:
      the router principal id

    • getDocumentTypeName

      String getDocumentTypeName()
      Retrieve the name of the type of this document
      Returns:
      the name of the type of this document

    • getDocumentTypeId

      String getDocumentTypeId()
      Retrieve the id of the type of this document
      Returns:
      the id of the type of this document

    • getDocumentHandlerUrl

      String getDocumentHandlerUrl()
      Retrieve the document handler url
      Returns:
      the document handler url

    • getApplicationDocumentStatus

      String getApplicationDocumentStatus()
      Retrieve the application document status. The Application Document Status is used to track document/applicaiton specific statuses
      Returns:
      the application document status

    • getApplicationDocumentStatusDate

      org.joda.time.DateTime getApplicationDocumentStatusDate()
      Retrieve the last application document status transition date. The Application Document Status date is the date the application document status last transitioned.
      Returns:
      the application document status date

    • getVariables

      Map<String,String> getVariables()
      Retrieve the currently defined internal workflow engine variables for the document NOTE: use of workflow engine variables is an advanced technique requiring specific crafting of the workflow document routing; these variables will not be useful for the majority of workflow use cases
      Returns:
      the currently defined workflow engine variables for the document