blackboard.data
Class AvailabilityFilter

java.lang.Object
  blackboard.base.ListFilter
      blackboard.data.AvailabilityFilter

Direct Known Subclasses:

CourseAvailabilityFilter

public class AvailabilityFilter
extends ListFilter

List Filter used to filter on the availability of an object. An object should implement Available in order to properly be used with this filter.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/06/27 $

See Also:

Available

Nested Class Summary

Nested classes/interfaces inherited from class blackboard.base.ListFilter

ListFilter.Comparison

Field Summary

static boolean	AVAILABLE_ONLY Can be provided to constructor as targetAvailability value
static boolean	NOT_AVAILABLE_ONLY Can be provided to constructor as targetAvailability value

Fields inherited from class blackboard.base.ListFilter

NOOP

Constructor Summary

AvailabilityFilter(boolean targetAvailability)
Constructs an availability filter than can be used to filter a list of objects based upon a provided availability value.

Method Summary

protected boolean

passesFilter(java.lang.Object obj) Implements passesFilter method of the ListFilter class.

Methods inherited from class blackboard.base.ListFilter

addFilter, passesFilters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AVAILABLE_ONLY

public static boolean AVAILABLE_ONLY

Can be provided to constructor as targetAvailability value

NOT_AVAILABLE_ONLY

public static boolean NOT_AVAILABLE_ONLY

Can be provided to constructor as targetAvailability value

Constructor Detail

AvailabilityFilter

public AvailabilityFilter(boolean targetAvailability)

Constructs an availability filter than can be used to filter a list of objects based upon a provided availability value.

Parameters:

targetAvailability - determines the availability value used to determine whether values pass the filter. Should be true if available items should pass the filter, false if unavailable items should pass the filter.

Method Detail

passesFilter

protected boolean passesFilter(java.lang.Object obj)

Implements passesFilter method of the ListFilter class.

Specified by:

passesFilter in class ListFilter