org.kuali.rice.core.api.criteria

Class InPredicate

java.lang.Object

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

org.kuali.rice.core.api.criteria.InPredicate

All Implemented Interfaces:

Serializable, MultiValuedPredicate, Predicate, PropertyPathPredicate, ModelObjectBasic, ModelObjectComplete

public final class InPredicate
extends AbstractDataTransferObject
implements MultiValuedPredicate

An immutable predicate which represents an "in" statement which is evaluated against a list of values.

Author:

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

See Also:

for a convenient way to construct this class., Serialized Form

Method Summary

Modifier and Type	Method and Description
String	getPropertyPath() Returns the property path for this predicate which represents the portion of the object model to which the predicate applies.
Set<CriteriaValue<?>>	getValues() Gets an immutable set of criteria values for this predicate.
String	toString() This will return a proper string representation of the Model Object.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectComplete

equals, hashCode

Method Detail

getPropertyPath

public String getPropertyPath()

Description copied from interface: PropertyPathPredicate

Returns the property path for this predicate which represents the portion of the object model to which the predicate applies.

Specified by:

getPropertyPath in interface PropertyPathPredicate

Returns:

the property path

getValues

public Set<CriteriaValue<?>> getValues()

Description copied from interface: MultiValuedPredicate

Gets an immutable set of criteria values for this predicate. All values should be of the same parameterized CriteriaValue type. The returned set can be empty but should never be null.

Specified by:

getValues in interface MultiValuedPredicate

Returns:

the set of criteria values for this predicate

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Returns:

the string representation