org.kuali.rice.kew.framework.document.search

Class DocumentSearchResultValues.Builder

java.lang.Object

org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, DocumentSearchResultValuesContract

Enclosing class:

DocumentSearchResultValues

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

A builder which can be used to construct DocumentSearchResultValues instances. Enforces the constraints of the DocumentSearchResultValuesContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
DocumentSearchResultValues	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static DocumentSearchResultValues.Builder	create() Creates new empty builder instance.
static DocumentSearchResultValues.Builder	create(DocumentSearchResultValuesContract contract) Creates a new builder instance initialized with copies of the properties from the given contract.
List<DocumentSearchResultValue.Builder>	getResultValues() Returns an unmodifiable list of the result values, one for each customized document.
void	setResultValues(List<DocumentSearchResultValue.Builder> resultValues)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DocumentSearchResultValues.Builder create()

Creates new empty builder instance. The various lists on this builder are initialized to empty lists. The internal list of result value builders is initialized to an empty list.

Returns:

a new empty builder instance

create

public static DocumentSearchResultValues.Builder create(DocumentSearchResultValuesContract contract)

Creates a new builder instance initialized with copies of the properties from the given contract.

Parameters:

contract - the contract from which to copy properties

Returns:

a builder instance initialized with properties from the given contract

Throws:

IllegalArgumentException - if the given contract is null

build

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

getResultValues

public List<DocumentSearchResultValue.Builder> getResultValues()

Description copied from interface: DocumentSearchResultValuesContract

Returns an unmodifiable list of the result values, one for each customized document.

Specified by:

getResultValues in interface DocumentSearchResultValuesContract

Returns:

the list of customized document search result values, will never be null but may be empty

setResultValues

public void setResultValues(List<DocumentSearchResultValue.Builder> resultValues)