com.highdeal.filter.hci

Interface SearchQueryResult

public interface SearchQueryResult

This Java interface provides a mechanism to build and execute a search query

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTES_RESULT_TYPE
static int	ID_RESULT_TYPE
static int	ITERATOR_MODE
static int	LIST_MODE
static int	OBJECT_RESULT_TYPE

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<AttributeSet>	getAttributeSetIterator() Gets an iterator which allow to iterate on the requested attribute sets; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not ATTRIBUTES_RESULT_TYPE.
java.util.Vector<AttributeSet>	getAttributeSetList() Gets the list of attributes for searched items
java.util.Iterator<?>	getIDIterator() Gets an iterator which allow to iterate on the requested object IDs; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not ID_RESULT_TYPE.
java.util.Vector<?>	getIDList() Gets the list of Ids for searched items; This method throws an IllegalStateException runtime exception if the SearchMode is not LIST_MODE or if the type is not ID_RESULT_TYPE.
java.lang.String	getLastID() Gets the last identifier of the result list
java.util.Iterator<? extends XMLMarshallable>	getObjectIterator() Gets an iterator which allow to iterate on the requested objects; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not OBJECT_RESULT_TYPE.
java.util.Vector<XMLMarshallable>	getObjectList() Gets the list of searched items; This method throws an IllegalStateException runtime exception if the SearchMode is not LIST_MODE or if the type is not OBJECT_RESULT_TYPE.
int	getResultType() Returns the result type (IDs or Object)
int	getSearchMode() Returns the search mode (LIST_MODE or ITERATOR_MODE)
int	getTotalCount() Returns the total count of targeted items if this count has been required in the search filter.

Field Detail

ID_RESULT_TYPE

static final int ID_RESULT_TYPE

See Also:

Constant Field Values

OBJECT_RESULT_TYPE

static final int OBJECT_RESULT_TYPE

See Also:

Constant Field Values

ATTRIBUTES_RESULT_TYPE

static final int ATTRIBUTES_RESULT_TYPE

See Also:

Constant Field Values

LIST_MODE

static final int LIST_MODE

See Also:

Constant Field Values

ITERATOR_MODE

static final int ITERATOR_MODE

See Also:

Constant Field Values

Method Detail

getSearchMode

int getSearchMode()

Returns the search mode (LIST_MODE or ITERATOR_MODE)

Returns:

The search mode

getResultType

int getResultType()

Returns the result type (IDs or Object)

Returns:

The result type

getIDList

java.util.Vector<?> getIDList()

Gets the list of Ids for searched items; This method throws an IllegalStateException runtime exception if the SearchMode is not LIST_MODE or if the type is not ID_RESULT_TYPE. If those identifiers are OID they represents the Database OID under which the object is stored.

Returns:

a vector of UID (java.lang.String).

getAttributeSetList

java.util.Vector<AttributeSet> getAttributeSetList()

Gets the list of attributes for searched items

Returns:

a vector of AttributeSet.

getObjectList

java.util.Vector<XMLMarshallable> getObjectList()

Gets the list of searched items; This method throws an IllegalStateException runtime exception if the SearchMode is not LIST_MODE or if the type is not OBJECT_RESULT_TYPE.

Returns:

a vector of items (XMLMarshallable objects).

getObjectIterator

java.util.Iterator<? extends XMLMarshallable> getObjectIterator()

Gets an iterator which allow to iterate on the requested objects; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not OBJECT_RESULT_TYPE.

Returns:

an iterator on items (XMLMarshallable objects).

getAttributeSetIterator

java.util.Iterator<AttributeSet> getAttributeSetIterator()

Gets an iterator which allow to iterate on the requested attribute sets; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not ATTRIBUTES_RESULT_TYPE.

Returns:

An iterator on items attributeSet

getIDIterator

java.util.Iterator<?> getIDIterator()

Gets an iterator which allow to iterate on the requested object IDs; This method throws an IllegalStateException runtime exception if the SearchMode is not ITERATOR_MODE or if the type is not ID_RESULT_TYPE.

Returns:

An iterator on object IDs (XMLMarshallable objects)

getTotalCount

int getTotalCount()

Returns the total count of targeted items if this count has been required in the search filter.

Returns:

The total count of targeted items

getLastID

java.lang.String getLastID()

Gets the last identifier of the result list

Returns:

The last identifier in the result list