Document.Builder (Rice 2.4.0-M5-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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()` Retrieve the application document id.
`String`	`getApplicationDocumentStatus()` Retrieve the application document status.
`org.joda.time.DateTime`	`getApplicationDocumentStatusDate()` Retrieve the last application document status transition date.
`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
`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