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

java.lang.Object
  org.kuali.rice.kew.api.document.Document.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, DocumentContract

Enclosing class:

Document

public static final class Document.Builder
extends Object
implements Serializable, ModelBuilder, DocumentContract

A builder which can be used to construct Document instances. Enforces the constraints of the DocumentContract.

See Also:

Serialized Form

Method Summary

Document	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static Document.Builder	create(DocumentContract contract)
static Document.Builder	create(String documentId, DocumentStatus status, org.joda.time.DateTime dateCreated, String initiatorPrincipalId, String documentTypeName, String documentTypeId)
static Document.Builder	create(String documentId, String initiatorPrinicpalId, String documentTypeName, String documentTypeId)
String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
org.joda.time.DateTime	getApplicationDocumentStatusDate()
org.joda.time.DateTime	getDateApproved()
org.joda.time.DateTime	getDateCreated()
org.joda.time.DateTime	getDateFinalized()
org.joda.time.DateTime	getDateLastModified()
String	getDocumentHandlerUrl()
String	getDocumentId()
String	getDocumentTypeId()
String	getDocumentTypeName()
String	getInitiatorPrincipalId()
String	getRoutedByPrincipalId()
DocumentStatus	getStatus()
String	getTitle()
Map<String,String>	getVariables()
void	setApplicationDocumentId(String applicationDocumentId)
void	setApplicationDocumentStatus(String applicationDocumentStatus)
void	setApplicationDocumentStatusDate(org.joda.time.DateTime applicationDocumentStatusDate)
void	setDateApproved(org.joda.time.DateTime dateApproved)
void	setDateCreated(org.joda.time.DateTime dateCreated)
void	setDateFinalized(org.joda.time.DateTime dateFinalized)
void	setDateLastModified(org.joda.time.DateTime dateLastModified)
void	setDocumentHandlerUrl(String documentHandlerUrl)
void	setDocumentId(String documentId)
void	setDocumentTypeId(String documentTypeId)
void	setDocumentTypeName(String documentTypeName)
void	setInitiatorPrincipalId(String initiatorPrincipalId)
void	setRoutedByPrincipalId(String routedByPrincipalId)
void	setStatus(DocumentStatus status)
void	setTitle(String title)
void	setVariables(Map<String,String> variables)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Document.Builder create(String documentId,
                                      DocumentStatus status,
                                      org.joda.time.DateTime dateCreated,
                                      String initiatorPrincipalId,
                                      String documentTypeName,
                                      String documentTypeId)

create

public static Document.Builder create(String documentId,
                                      String initiatorPrinicpalId,
                                      String documentTypeName,
                                      String documentTypeId)

create

public static Document.Builder create(DocumentContract contract)

build

public Document build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

getDocumentId

public String getDocumentId()

Specified by:

getDocumentId in interface DocumentContract

getStatus

public DocumentStatus getStatus()

Specified by:

getStatus in interface DocumentContract

getDateCreated

public org.joda.time.DateTime getDateCreated()

Specified by:

getDateCreated in interface DocumentContract

getDateLastModified

public org.joda.time.DateTime getDateLastModified()

Specified by:

getDateLastModified in interface DocumentContract

getDateApproved

public org.joda.time.DateTime getDateApproved()

Specified by:

getDateApproved in interface DocumentContract

getDateFinalized

public org.joda.time.DateTime getDateFinalized()

Specified by:

getDateFinalized in interface DocumentContract

getTitle

public String getTitle()

Specified by:

getTitle in interface DocumentContract

getApplicationDocumentId

public String getApplicationDocumentId()

Specified by:

getApplicationDocumentId in interface DocumentContract

getInitiatorPrincipalId

public String getInitiatorPrincipalId()

Specified by:

getInitiatorPrincipalId in interface DocumentContract

getRoutedByPrincipalId

public String getRoutedByPrincipalId()

Specified by:

getRoutedByPrincipalId in interface DocumentContract

getDocumentTypeName

public String getDocumentTypeName()

Specified by:

getDocumentTypeName in interface DocumentContract

getDocumentTypeId

public String getDocumentTypeId()

Specified by:

getDocumentTypeId in interface DocumentContract

getDocumentHandlerUrl

public String getDocumentHandlerUrl()

Specified by:

getDocumentHandlerUrl in interface DocumentContract

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

Specified by:

getApplicationDocumentStatus in interface DocumentContract

getApplicationDocumentStatusDate

public org.joda.time.DateTime getApplicationDocumentStatusDate()

Specified by:

getApplicationDocumentStatusDate in interface DocumentContract

getVariables

public Map<String,String> getVariables()

Specified by:

getVariables in interface DocumentContract

setDocumentId

public void setDocumentId(String documentId)

setStatus

public void setStatus(DocumentStatus status)

setDateCreated

public void setDateCreated(org.joda.time.DateTime dateCreated)

setDateLastModified

public void setDateLastModified(org.joda.time.DateTime dateLastModified)

setDateApproved

public void setDateApproved(org.joda.time.DateTime dateApproved)

setDateFinalized

public void setDateFinalized(org.joda.time.DateTime dateFinalized)

setTitle

public void setTitle(String title)

setApplicationDocumentId

public void setApplicationDocumentId(String applicationDocumentId)

setInitiatorPrincipalId

public void setInitiatorPrincipalId(String initiatorPrincipalId)

setRoutedByPrincipalId

public void setRoutedByPrincipalId(String routedByPrincipalId)

setDocumentTypeName

public void setDocumentTypeName(String documentTypeName)

setDocumentTypeId

public void setDocumentTypeId(String documentTypeId)

setDocumentHandlerUrl

public void setDocumentHandlerUrl(String documentHandlerUrl)

setApplicationDocumentStatus

public void setApplicationDocumentStatus(String applicationDocumentStatus)

setApplicationDocumentStatusDate

public void setApplicationDocumentStatusDate(org.joda.time.DateTime applicationDocumentStatusDate)

setVariables

public void setVariables(Map<String,String> variables)