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

Interface IQueryEntryList

All Superinterfaces:

Serializable

public interface IQueryEntryList
extends Serializable

List of IQueryEntry objects
Changes between major releases 7.0 and 7.X

• Added methods: addDateRangeQuery(IPropertyName, long, byte) clear() fromXMLString(String) toXMLString() toXMLStringSave()

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.
void	addBracketClose() Adds a closing bracket to the end of the list.
void	addBracketOpen() Adds an opening bracket to the end of the list.
void	addContentQuery(String term) Add a content query to the end of the list.
void	addContentQuery(String term, byte operator, byte termAction) Add a content query to the end of the list.
void	addDateRangeQuery(IPropertyName pName, long timeDif, byte propOp) Add an date range query to the end of the list. he used timestanp is defined as the current timestamp minus the milliseconds specified by timeDif.
void	addNotOperator() Adds a NOT operator to the end of the list.
void	addOrOperator() Adds an OR operator to the end of the list.
void	clear() Clears the query entry list
IQueryEntryList	createEmptyQueryEntryList() Creates a new empty query entry list.
void	fromXMLString(String s) Reads the string definition of a query entry list and creates the queries for the object.
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)
String	toXMLString() Returns a string definition of the object.
String	toXMLStringSave() Returns a string definition of the object.

Method Detail

size

int size()

Returns:

number of query entries

add

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

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

IQueryEntry get(int index)

Parameters:

index - - position in the query entry list

Returns:

query entry at the specified position (index)

indexOf

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

IQueryEntryListIterator listIterator()

Returns:

list iterator for the query entry list

add

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

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()).

clear

void clear()

Clears the query entry list

subList

IQueryEntryList subList(int from,
                        int to)

addAndOperator

void addAndOperator()
                    throws com.sapportals.wcm.WcmException

Adds an AND operator to the end of the list.

Throws:

com.sapportals.wcm.WcmException

addOrOperator

void addOrOperator()
                   throws com.sapportals.wcm.WcmException

Adds an OR operator to the end of the list.

Throws:

com.sapportals.wcm.WcmException

addNotOperator

void addNotOperator()
                    throws com.sapportals.wcm.WcmException

Adds a NOT operator to the end of the list.

Throws:

com.sapportals.wcm.WcmException

addBracketOpen

void addBracketOpen()
                    throws com.sapportals.wcm.WcmException

Adds an opening bracket to the end of the list.

Throws:

com.sapportals.wcm.WcmException

addBracketClose

void addBracketClose()
                     throws com.sapportals.wcm.WcmException

Adds a closing bracket to the end of the list.

Throws:

com.sapportals.wcm.WcmException

addAttributeQuery

void addAttributeQuery(IPropertyName pName,
                       String value,
                       byte propOp)
                       throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException

addContentQuery

void addContentQuery(String term)
                     throws com.sapportals.wcm.WcmException

Add a content query to the end of the list. Thereby the operator IQueryEntry.PROPERTY_OPERATOR_EQUAL and the term action IQueryEntry.TERM_ACTION_EXACT are used.

Parameters:

term -

Throws:

com.sapportals.wcm.WcmException

addContentQuery

void addContentQuery(String term,
                     byte operator,
                     byte termAction)
                     throws com.sapportals.wcm.WcmException

Add a content query to the end of the list. As allowed operators you can use IQueryEntry.PROPERTY_OPERATOR_EQUAL and IQueryEntry.PROPERTY_OPERATOR_NOT. As allowed termaction you can use IQueryEntry.TERM_ACTION_EXACT, IQueryEntry.TERM_ACTION_FUZZY, IQueryEntry.TERM_ACTION_LINGUISTIC and IQueryEntry.TERM_ACTION_SOUNDEX.

Parameters:

term -

operator -

termAction -

Throws:

com.sapportals.wcm.WcmException

addDateRangeQuery

void addDateRangeQuery(IPropertyName pName,
                       long timeDif,
                       byte propOp)
                       throws com.sapportals.wcm.WcmException

Add an date range query to the end of the list. he used timestanp is defined as the current timestamp minus the milliseconds specified by timeDif.

Parameters:

pName - Property

timeDif -

propOp - Operator

Throws:

com.sapportals.wcm.WcmException

toXMLString

String toXMLString()
                   throws com.sapportals.wcm.WcmException

Returns a string definition of the object.

Returns:

Throws:

com.sapportals.wcm.WcmException

toXMLStringSave

String toXMLStringSave()

Returns a string definition of the object. It never throws an exception in case of an error.

Returns:

fromXMLString

void fromXMLString(String s)
                   throws com.sapportals.wcm.WcmException

Reads the string definition of a query entry list and creates the queries for the object.

Parameters:

s -

Throws:

com.sapportals.wcm.WcmException

createEmptyQueryEntryList

IQueryEntryList createEmptyQueryEntryList()

Creates a new empty query entry list.

Returns:

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM