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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentSearchResultValueContract

public final class DocumentSearchResultValue
extends AbstractDataTransferObject
implements DocumentSearchResultValueContract

An immutable data transfer object implementation of the DocumentSearchResultValueContract. Instances of this class should be constructed using the nested DocumentSearchResultValue.Builder class.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

static class

DocumentSearchResultValue.Builder A builder which can be used to construct DocumentSearchResultValue instances.

Method Summary

List<DocumentAttribute>	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.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDocumentId

public String getDocumentId()

Description copied from interface: DocumentSearchResultValueContract

Returns the id of the document for which this customized result value applies.

Specified by:

getDocumentId in interface DocumentSearchResultValueContract

Returns:

the document id of the customized document search result

getDocumentAttributes

public List<DocumentAttribute> getDocumentAttributes()

Description copied from interface: DocumentSearchResultValueContract

Returns the customized document attribute values for this document search result.

Specified by:

getDocumentAttributes in interface DocumentSearchResultValueContract

Returns:

the customized document attribute values for this document search result