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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.document.attribute.DocumentAttribute

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentAttributeContract

Direct Known Subclasses:

DocumentAttributeDateTime, DocumentAttributeDecimal, DocumentAttributeInteger, DocumentAttributeString

public abstract class DocumentAttribute
extends AbstractDataTransferObject
implements DocumentAttributeContract

An abstract representation of the DocumentAttributeContract which can be used as the super class for concrete immutable data transfer object implementations of document attributes. This class also defines an abstract builder implementation which can be extended by it's subclasses to create their own internal builder implementations.

The KEW api defines the understood set of document attribute implementations, so it is not generally of value for a client of the api to subclass this class.

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class

DocumentAttribute.AbstractBuilder<T> An abstract base class that can be extended by concrete builder implementations of subclasses of DocumentAttribute.

Constructor Summary

protected

DocumentAttribute()

Method Summary

String

getName() Returns the name of this document attribute which serves as an identifier for this attribute on the document.

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

afterUnmarshal, beforeUnmarshal, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kew.api.document.attribute.DocumentAttributeContract

getDataType, getValue

Constructor Detail

DocumentAttribute

protected DocumentAttribute()

Method Detail

getName

public String getName()

Description copied from interface: DocumentAttributeContract

Returns the name of this document attribute which serves as an identifier for this attribute on the document. A document may have more then one attribute with the same name, in which case it is treated as a multi-valued attribute. This method should never return a null or blank value.

Specified by:

getName in interface DocumentAttributeContract

Returns:

the name of the document attribute