org.kuali.rice.kew.api.document

Class DocumentUpdate.Builder

java.lang.Object

org.kuali.rice.kew.api.document.DocumentUpdate.Builder

All Implemented Interfaces:

Serializable, ModelBuilder

Enclosing class:

DocumentUpdate

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

A builder which can be used to construct DocumentUpdate instances.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	addDirtyField(String field)
DocumentUpdate	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static DocumentUpdate.Builder	create()
static DocumentUpdate.Builder	create(Document document)
String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
List<String>	getDirtyFields()
String	getTitle()
Map<String,String>	getVariables()
String	getVariableValue(String name)
void	setApplicationDocumentId(String applicationDocumentId)
void	setApplicationDocumentStatus(String applicationDocumentStatus)
void	setDirtyFields(List<String> dirtyFields)
void	setTitle(String title) Sets the document title - will be truncated to KewApiConstants.TITLE_MAX_LENGTH length.
void	setVariable(String name, String value)
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 DocumentUpdate.Builder create()

create

public static DocumentUpdate.Builder create(Document document)

build

public DocumentUpdate 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

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

Sets the document title - will be truncated to KewApiConstants.TITLE_MAX_LENGTH length.

getApplicationDocumentId

public String getApplicationDocumentId()

setApplicationDocumentId

public void setApplicationDocumentId(String applicationDocumentId)

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

setApplicationDocumentStatus

public void setApplicationDocumentStatus(String applicationDocumentStatus)

setVariables

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

getVariables

public Map<String,String> getVariables()

getVariableValue

public String getVariableValue(String name)

setVariable

public void setVariable(String name,
               String value)

getDirtyFields

public List<String> getDirtyFields()

setDirtyFields

public void setDirtyFields(List<String> dirtyFields)

addDirtyField

public void addDirtyField(String field)