|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder
public static final class DocumentSearchResultValue.Builder
A builder which can be used to construct DocumentSearchResultValue
instances. Enforces the constraints
of the DocumentSearchResultValueContract
.
Method Summary | |
---|---|
DocumentSearchResultValue |
build()
Returns an instance of the object being built by this builder based on the current state of the builder. |
static DocumentSearchResultValue.Builder |
create(DocumentSearchResultValueContract contract)
Creates a new builder instance initialized with copies of the properties from the given contract. |
static DocumentSearchResultValue.Builder |
create(String documentId)
Creates a new builder instance initialized with the given document id. |
List<DocumentAttribute.AbstractBuilder<?>> |
getDocumentAttributes()
Returns the customized document attribute values for this document search result. |
String |
getDocumentId()
Returns the id of the document for which this customized result value applies. |
void |
setDocumentAttributes(List<DocumentAttribute.AbstractBuilder<?>> documentAttributes)
Sets the list of document attribute builders on this builder to the given list. |
void |
setDocumentId(String documentId)
Sets the document id on this builder to the given value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DocumentSearchResultValue.Builder create(String documentId)
documentId
- the id of the document with which to initialize this builder, must not be a null or blank
value
public static DocumentSearchResultValue.Builder create(DocumentSearchResultValueContract contract)
contract
- the contract from which to copy properties
IllegalArgumentException
- if the given contract is nullpublic DocumentSearchResultValue build()
ModelBuilder
build
in interface ModelBuilder
public String getDocumentId()
DocumentSearchResultValueContract
getDocumentId
in interface DocumentSearchResultValueContract
public List<DocumentAttribute.AbstractBuilder<?>> getDocumentAttributes()
DocumentSearchResultValueContract
getDocumentAttributes
in interface DocumentSearchResultValueContract
public void setDocumentId(String documentId)
documentId
- the id of the document to set on this builder, must not be a null or blank value
IllegalArgumentException
- if documentId is a null or blank valuepublic void setDocumentAttributes(List<DocumentAttribute.AbstractBuilder<?>> documentAttributes)
documentAttributes
- the list of document attribute builders to set on this builder
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |