org.kuali.rice.kew.api.document
Class Document

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.document.Document

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentContract

public final class Document
extends AbstractDataTransferObject
implements DocumentContract

See Also:

Serialized Form

Nested Class Summary

static class

Document.Builder A builder which can be used to construct Document instances.

Method Summary

String	getApplicationDocumentId() Retrieve the application document id.
String	getApplicationDocumentStatus() Retrieve the application document status.
org.joda.time.DateTime	getApplicationDocumentStatusDate() Retrieve the application document status date TODO: explain what the application document status date field is
org.joda.time.DateTime	getDateApproved() Retrieve the document approval date
org.joda.time.DateTime	getDateCreated() Retrieve the document creation date
org.joda.time.DateTime	getDateFinalized() Retrieve the document finalization date
org.joda.time.DateTime	getDateLastModified() Retrieve the document last-modified date
String	getDocumentHandlerUrl() Retrieve the document handler url
String	getDocumentId() Retrieve the document id
String	getDocumentTypeId() Retrieve the id of the type of this document
String	getDocumentTypeName() Retrieve the name of the type of this document
String	getInitiatorPrincipalId() Retrieve the initiator principal id
String	getRoutedByPrincipalId() Retrieve the router principal id
DocumentStatus	getStatus() Retrieve the document status
String	getTitle() Retrieve the document title
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

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDocumentId

public String getDocumentId()

Description copied from interface: DocumentContract

Retrieve the document id

Specified by:

getDocumentId in interface DocumentContract

Returns:

the document id

getStatus

public DocumentStatus getStatus()

Description copied from interface: DocumentContract

Retrieve the document status

Specified by:

getStatus in interface DocumentContract

Returns:

the document status

getDateCreated

public org.joda.time.DateTime getDateCreated()

Description copied from interface: DocumentContract

Retrieve the document creation date

Specified by:

getDateCreated in interface DocumentContract

Returns:

the document creation date or null

getDateLastModified

public org.joda.time.DateTime getDateLastModified()

Description copied from interface: DocumentContract

Retrieve the document last-modified date

Specified by:

getDateLastModified in interface DocumentContract

Returns:

the document last-modified date or null

getDateApproved

public org.joda.time.DateTime getDateApproved()

Description copied from interface: DocumentContract

Retrieve the document approval date

Specified by:

getDateApproved in interface DocumentContract

Returns:

the document approval date or null

getDateFinalized

public org.joda.time.DateTime getDateFinalized()

Description copied from interface: DocumentContract

Retrieve the document finalization date

Specified by:

getDateFinalized in interface DocumentContract

Returns:

the document finalization date or null

getTitle

public String getTitle()

Description copied from interface: DocumentContract

Retrieve the document title

Specified by:

getTitle in interface DocumentContract

Returns:

the document title

getApplicationDocumentId

public String getApplicationDocumentId()

Description copied from interface: DocumentContract

Retrieve the application document id. The Application Document Id is used to record an application-relevant id for the workflow document.

Specified by:

getApplicationDocumentId in interface DocumentContract

Returns:

the application document id

getInitiatorPrincipalId

public String getInitiatorPrincipalId()

Description copied from interface: DocumentContract

Retrieve the initiator principal id

Specified by:

getInitiatorPrincipalId in interface DocumentContract

Returns:

the initiator principal id

getRoutedByPrincipalId

public String getRoutedByPrincipalId()

Description copied from interface: DocumentContract

Retrieve the router principal id

Specified by:

getRoutedByPrincipalId in interface DocumentContract

Returns:

the router principal id

getDocumentTypeName

public String getDocumentTypeName()

Description copied from interface: DocumentContract

Retrieve the name of the type of this document

Specified by:

getDocumentTypeName in interface DocumentContract

Returns:

the name of the type of this document

getDocumentTypeId

public String getDocumentTypeId()

Description copied from interface: DocumentContract

Retrieve the id of the type of this document

Specified by:

getDocumentTypeId in interface DocumentContract

Returns:

the id of the type of this document

getDocumentHandlerUrl

public String getDocumentHandlerUrl()

Description copied from interface: DocumentContract

Retrieve the document handler url

Specified by:

getDocumentHandlerUrl in interface DocumentContract

Returns:

the document handler url

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

Description copied from interface: DocumentContract

Retrieve the application document status. The Application Document Status is used to track document/applicaiton specific statuses

Specified by:

getApplicationDocumentStatus in interface DocumentContract

Returns:

the application document status

getApplicationDocumentStatusDate

public org.joda.time.DateTime getApplicationDocumentStatusDate()

Description copied from interface: DocumentContract

Retrieve the application document status date TODO: explain what the application document status date field is

Specified by:

getApplicationDocumentStatusDate in interface DocumentContract

Returns:

the application document status date

getVariables

public Map<String,String> getVariables()

Description copied from interface: DocumentContract

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

Specified by:

getVariables in interface DocumentContract

Returns:

the currently defined workflow engine variables for the document