com.sap.security.api

Interface ISearchResult

All Superinterfaces:
Iterator

public interface ISearchResult
extends Iterator

A read-only iterator that can return the size of the iteration


Field Summary
static int SEARCH_RESULT_INCOMPLETE
          Constant used to define that the search result is not complete
static int SEARCH_RESULT_OK
          Constant used to define that the search was done successfully
static int SEARCH_RESULT_UNDEFINED
          Constant used to define that the search result is undefined
static int SIZE_LIMIT_EXCEEDED
          Constant used to define that a size limit exceeded occured
static int TIME_LIMIT_EXCEEDED
          Constant used to define that a time limit exceeded occured
 
Method Summary
 int getState()
          Returns the status of the search result
 int size()
          Returns the number of elements in the iteration.
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Field Detail

SEARCH_RESULT_OK

public static final int SEARCH_RESULT_OK
Constant used to define that the search was done successfully

See Also:
Constant Field Values

SEARCH_RESULT_INCOMPLETE

public static final int SEARCH_RESULT_INCOMPLETE
Constant used to define that the search result is not complete

See Also:
Constant Field Values

SEARCH_RESULT_UNDEFINED

public static final int SEARCH_RESULT_UNDEFINED
Constant used to define that the search result is undefined

See Also:
Constant Field Values

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED
Constant used to define that a size limit exceeded occured

See Also:
Constant Field Values

TIME_LIMIT_EXCEEDED

public static final int TIME_LIMIT_EXCEEDED
Constant used to define that a time limit exceeded occured

See Also:
Constant Field Values
Method Detail

size

public int size()
Returns the number of elements in the iteration.


getState

public int getState()
Returns the status of the search result

Returns:
int: returns constants of interface ISearchResult: SEARCH_RESULT_OK, SEARCH_RESULT_INCOMPLETE, SIZE_LIMIT_EXCEEDED, TIME_LIMIT_EXCEEDED, SEARCH_RESULT_UNDEFINED


Copyright 2006 SAP AG Complete Copyright Notice