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

Class DocumentSearchCriteriaConfiguration.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, ModelBuilder, DocumentSearchCriteriaConfigurationContract

Enclosing class:

DocumentSearchCriteriaConfiguration

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

A builder which can be used to construct DocumentSearchCriteriaConfiguration instances. Enforces the constraints of the DocumentSearchCriteriaConfigurationContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
DocumentSearchCriteriaConfiguration	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static DocumentSearchCriteriaConfiguration.Builder	create() Creates new empty builder instance.
static DocumentSearchCriteriaConfiguration.Builder	create(DocumentSearchCriteriaConfigurationContract contract) Creates a new builder instance initialized with copies of the properties from the given contract.
List<AttributeFields>	getSearchAttributeFields() Returns the additional attribute fields that should be included as part of the document search criteria on the document search user interface.
void	setSearchAttributeFields(List<AttributeFields> searchAttributeFields) Sets the search attribute fields on this builder to the given list of attribute fields.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DocumentSearchCriteriaConfiguration.Builder create()

Creates new empty builder instance. The list of search attributes on this builder is intialized to an empty list.

Returns:

a new empty builder instance

create

public static DocumentSearchCriteriaConfiguration.Builder create(DocumentSearchCriteriaConfigurationContract 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 DocumentSearchCriteriaConfiguration 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

getSearchAttributeFields

public List<AttributeFields> getSearchAttributeFields()

Description copied from interface: DocumentSearchCriteriaConfigurationContract

Returns the additional attribute fields that should be included as part of the document search criteria on the document search user interface.

Specified by:

getSearchAttributeFields in interface DocumentSearchCriteriaConfigurationContract

Returns:

the search attribute fields that are part of this configuration

setSearchAttributeFields

public void setSearchAttributeFields(List<AttributeFields> searchAttributeFields)

Sets the search attribute fields on this builder to the given list of attribute fields.

Parameters:

searchAttributeFields - the list of search attribute fields to set