com.sapportals.wcm.service.indexmanagement.retrieval.search

Interface IQueryEntryList

All Superinterfaces:

Serializable

public interface IQueryEntryList

extends Serializable

List of IQueryEntry objects

Method Summary

void	add(int index, IQueryEntry queryEntry) Inserts the query entry at the specified position in this list.
boolean	add(IQueryEntry queryEntry) Adds a query entry to the query entry list
boolean	addAll(IQueryEntryList queryEntryList) Adds another query entry list to the query entry list
void	addAndOperator() Adds an AND operator to the end of the list.
void	addAttributeQuery(IPropertyName pName, String value, byte propOp) Adds a property query to the end of the list.
IQueryEntry	get(int index)
int	indexOf(IQueryEntry queryEntry)
IQueryEntryListIterator	listIterator()
IQueryEntry	remove(int index) Removes the query entry at the specified position in this list.
int	size()
IQueryEntryList	subList(int from, int to)

Method Detail

size

public int size()

Returns:

number of query entries

add

public boolean add(IQueryEntry queryEntry)

Adds a query entry to the query entry list

Parameters:

queryEntry - - query entry to add to query

Returns:

true if result added successfully

addAll

public boolean addAll(IQueryEntryList queryEntryList)

Adds another query entry list to the query entry list

Parameters:

queryEntryList - query entry list to add to the query

Returns:

true if list added successfully

get

public IQueryEntry get(int index)

Parameters:

index - - position in the query entry list

Returns:

query entry at the specified position (index)

indexOf

public int indexOf(IQueryEntry queryEntry)

Parameters:

queryEntry - - query entry for that the position in the list has to be determined

Returns:

position(index) of the search result in the list

listIterator

public IQueryEntryListIterator listIterator()

Returns:

list iterator for the query entry list

add

public void add(int index,
                IQueryEntry queryEntry)

Inserts the query entry at the specified position in this list. Shifts the query entry currently at that position (if any) and any subsequent query entries to the right (adds one to their indices).

Parameters:

index - index at which the specified query entry is to be inserted.

queryEntry - query entry to be inserted.

Throws:

IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index > size()).

remove

public IQueryEntry remove(int index)

Removes the query entry at the specified position in this list. Shifts any subsequent query entries to the left (subtracts one from their indices). Returns the query entry that was removed from the list.

Parameters:

index - the index of the query entry to be removed.

Returns:

the query entry previously at the specified position.

Throws:

IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index >= size()).

subList

public IQueryEntryList subList(int from,
                               int to)

addAndOperator

public void addAndOperator()
                    throws WcmException

Adds an AND operator to the end of the list.

Throws:

WcmException

addAttributeQuery

public void addAttributeQuery(IPropertyName pName,
                              String value,
                              byte propOp)
                       throws WcmException

Adds a property query to the end of the list.

Parameters:

pName - name of the property

value - value as a string

propOp - operator to be used

Throws:

WcmException