org.kuali.rice.kew.api.document.attribute

Class DocumentAttributeString

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.document.attribute.DocumentAttribute

org.kuali.rice.kew.api.document.attribute.DocumentAttributeString

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentAttributeContract

public final class DocumentAttributeString
extends DocumentAttribute

A document attribute which contains character data. Construct instances of DocumentAttributeString using it's builder or the DocumentAttributeFactory.

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentAttributeString.Builder A builder implementation which allows for construction of a DocumentAttributeString.

Nested classes/interfaces inherited from class org.kuali.rice.kew.api.document.attribute.DocumentAttribute

DocumentAttribute.AbstractBuilder<T>

Method Summary

Modifier and Type	Method and Description
DocumentAttributeDataType	getDataType() Returns the data type of this document attribute.
String	getValue() Returns the value of this document attribute.

Methods inherited from class org.kuali.rice.kew.api.document.attribute.DocumentAttribute

getName

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

getValue

public String getValue()

Description copied from interface: DocumentAttributeContract

Returns the value of this document attribute. It can be of any type as defined by the implementations of this interface. It is possible that this value may be null in cases where the document has a particular attribute but no actual value associated with that attribute.

Returns:

the value of the document attribute

getDataType

public DocumentAttributeDataType getDataType()

Description copied from interface: DocumentAttributeContract

Returns the data type of this document attribute. This will generally inform the type of object returned from the #getValue method. This method should never return a null value.

Returns:

the data type of this document attribute