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

Field Summary

private String	applicationDocumentId
private String	applicationDocumentStatus
private static long	serialVersionUID
private String	title
private Map<String,String>	variables

Constructor Summary

private

DocumentUpdate.Builder()

Method Summary

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()
String	getTitle()
Map<String,String>	getVariables()
String	getVariableValue(String name)
void	setApplicationDocumentId(String applicationDocumentId)
void	setApplicationDocumentStatus(String applicationDocumentStatus)
void	setTitle(String title) TODO: document the fact that this will auto-truncate the title...
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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

title

private String title

applicationDocumentId

private String applicationDocumentId

applicationDocumentStatus

private String applicationDocumentStatus

variables

private Map<String,String> variables

Constructor Detail

DocumentUpdate.Builder

private DocumentUpdate.Builder()

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)

TODO: document the fact that this will auto-truncate the title...

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)