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

Class AttributeFields

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete

public final class AttributeFields
extends AbstractDataTransferObject

An immutable data transfer object used to hold a list of RemotableAttributeField objects and the name of the SearchableAttribute from which the fields are derived. This is essentially used as a grouping mechanism in order to identify which fields are sourced from which attributes.

Since this class serves primarily as a simple wrapper for use by DocumentSearchCriteriaConfiguration, it does not have a builder, only a single static create method that is used for constructing instances of it.

Author:

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static AttributeFields	create(String attributeName, List<RemotableAttributeField> attributeFields) Construct a new instance of AttributeFields with the given attribute name and list of remotable attribute fields.
String	getAttributeName() Returns the name of the searchable attribute associated with this attribute fields instance.
List<RemotableAttributeField>	getRemotableAttributeFields() Returns a list of remotable attribute fields associated with the searchable attribute name of this instance.

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

create

public static AttributeFields create(String attributeName,
                     List<RemotableAttributeField> attributeFields)

Construct a new instance of AttributeFields with the given attribute name and list of remotable attribute fields.

Parameters:

attributeName - the name of the attribute, must not be a null or blank value

attributeFields - the remotable attribute fields to associate with the given attribute name

Returns:

a new AttributeFields instance containing the given values

Throws:

IllegalArgumentException - if the given attributeName is blank or null

getAttributeName

public String getAttributeName()

Returns the name of the searchable attribute associated with this attribute fields instance. Should never return a null or blank value.

Returns:

the searchable attribute name of this instance

getRemotableAttributeFields

public List<RemotableAttributeField> getRemotableAttributeFields()

Returns a list of remotable attribute fields associated with the searchable attribute name of this instance. This should never return a null reference, though the list returned can be empty.

Returns:

a list of remotable attribute fields associated with this instance