oracle.apps.fnd.applcore.globalSearch.ui
Class SearchFilterItems

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.SearchFilterItems

All Implemented Interfaces:

java.io.Serializable

public class SearchFilterItems
extends java.lang.Object
implements java.io.Serializable

A container of SearchFilterItems.

Author:

David Groves <david.groves@oracle.com>

See Also:

SearchFilterItem, CategorySearchFilterItem, KeywordSearchFilterItem, FacetItemSearchFilterItem, Serialized Form

Constructor Summary

SearchFilterItems()
Create an empty List of Items.

SearchFilterItems(SearchFilterItems copy)
Copy Constructor.

SearchFilterItems(SearchFilterItems copy, SearchFilterItem.FilterType filterType)
Partial Copy Constructor.

SearchFilterItems(SearchFilterItems copy, SearchFilterItem.FilterType[] filterTypes)
Partial Copy Constructor.

Method Summary

boolean	add(SearchFilterItem item) Add the given item to the end of the collection.
void	add(SearchFilterItem item, int position) Add the given item at the relvant position in the collection.
boolean	addAll(java.util.List<SearchFilterItem> items) Appends all of the elements in the specified collection to the end of this list, in the order they exist in items.
boolean	addAll(SearchFilterItems items) Appends all of the elements in the specified collection to the end of this list, in the order they exist in items.
boolean	contains(SearchFilterItem.FilterType filterType, java.lang.String value) Returns true if the collection of items contains a SearchFilterItem with the value specified of type filterType.
boolean	contains(SearchFilterItem value) Returns true if the collection of items contains the value specified.
boolean	equals(java.lang.Object obj)
SearchFilterItem	get(int index) Returns the element at the specified position in this list.
SearchFilterItem	getItemOfType(SearchFilterItem.FilterType filterType) Get the first item of the passed type.
java.util.List<SearchFilterItem>	getItems() Get the internal List - for EL iterator access.
boolean	hasFilterType(SearchFilterItem.FilterType filterType) Is there an item with this filterType in the collection?
int	hashCode()
int	indexOf(SearchFilterItem value) Returns true if this list contains the specified element.
boolean	remove(SearchFilterItem item) Removes the first occurrence in this list of the specified element.
boolean	removeAll(SearchFilterItem.FilterType filterType) Remove All items of the passed type.
int	size() Returns the number of elements in this list.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilterItems

public SearchFilterItems()

Create an empty List of Items.

SearchFilterItems

public SearchFilterItems(SearchFilterItems copy)

Copy Constructor. This constructor will reference copy's values. Order will be preserved.

Parameters:

copy - Collection to copy.

SearchFilterItems

public SearchFilterItems(SearchFilterItems copy,
                         SearchFilterItem.FilterType filterType)

Partial Copy Constructor. This constructor will reference copy's values for only the given filterType. Order will be preserved.

Parameters:

copy - Collection to copy.

filterType - filterType of items to copy.

SearchFilterItems

public SearchFilterItems(SearchFilterItems copy,
                         SearchFilterItem.FilterType[] filterTypes)

Partial Copy Constructor. This constructor will reference copy's values for only the given filterTypes. Order will be preserved.

Parameters:

copy - Collection to copy.

filterTypes - filterTypes of items to copy.

Method Detail

add

public boolean add(SearchFilterItem item)

Add the given item to the end of the collection.

Parameters:

item - item to add.

Returns:

true (as per the general contract of the Collection.add method).

add

public void add(SearchFilterItem item,
                int position)

Add the given item at the relvant position in the collection.

Parameters:

item - item to add.

position - 0 based index at which the specified element is to be inserted.

addAll

public boolean addAll(java.util.List<SearchFilterItem> items)

Appends all of the elements in the specified collection to the end of this list, in the order they exist in items.

Parameters:

items - collection whose elements are to be added to this list.

Returns:

true if this list changed as a result of the call.

addAll

public boolean addAll(SearchFilterItems items)

Appends all of the elements in the specified collection to the end of this list, in the order they exist in items.

Parameters:

items - collection whose elements are to be added to this list.

Returns:

true if this list changed as a result of the call.

get

public SearchFilterItem get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

remove

public boolean remove(SearchFilterItem item)

Removes the first occurrence in this list of the specified element. If this list does not contain the element, it is unchanged.

Parameters:

item - element to be removed from this list, if present.

Returns:

true if this list contained the specified element.

removeAll

public boolean removeAll(SearchFilterItem.FilterType filterType)

Remove All items of the passed type.

Parameters:

filterType - type to check.

Returns:

true if some items removed, false otherwise.

size

public int size()

Returns the number of elements in this list.

Returns:

the number of elements in this list.

contains

public boolean contains(SearchFilterItem value)

Returns true if the collection of items contains the value specified.

Parameters:

value - element whose presence in the items is to be tested

Returns:

true if the items contain the specified value

indexOf

public int indexOf(SearchFilterItem value)

Returns true if this list contains the specified element.

Parameters:

value - element whose presence in this list is to be tested.

Returns:

true if this list contains the specified element.

getItems

public java.util.List<SearchFilterItem> getItems()

Get the internal List - for EL iterator access.

Returns:

list of items.

hasFilterType

public boolean hasFilterType(SearchFilterItem.FilterType filterType)

Is there an item with this filterType in the collection?

Parameters:

filterType - type to check.

Returns:

true if collection has at least 1 item of this type, false otherwise.

getItemOfType

public SearchFilterItem getItemOfType(SearchFilterItem.FilterType filterType)

Get the first item of the passed type.

Parameters:

filterType - type to check.

Returns:

Found SearchFilterItem or null if none.

contains

public boolean contains(SearchFilterItem.FilterType filterType,
                        java.lang.String value)

Returns true if the collection of items contains a SearchFilterItem with the value specified of type filterType.

Parameters:

filterType - the type of filter item required

value - the value of the item to test

Returns:

true if a filter item exists matching the criteria provided

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object