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

Iterator	getMessages(boolean clearPermanentMessages) Returns an iterator which contains the IMessage objects assigned to this IPrincipal or null if no messages are assigned.
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

static final int SEARCH_RESULT_OK

Constant used to define that the search was done successfully

See Also:

Constant Field Values

SEARCH_RESULT_INCOMPLETE

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

static final int SEARCH_RESULT_UNDEFINED

Constant used to define that the search result is undefined

See Also:

Constant Field Values

SIZE_LIMIT_EXCEEDED

static final int SIZE_LIMIT_EXCEEDED

Constant used to define that a size limit exceeded occured

See Also:

Constant Field Values

TIME_LIMIT_EXCEEDED

static final int TIME_LIMIT_EXCEEDED

Constant used to define that a time limit exceeded occured

See Also:

Constant Field Values

Method Detail

size

int size()

Returns the number of elements in the iteration.

getState

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

getMessages

Iterator getMessages(boolean clearPermanentMessages)

Returns an iterator which contains the IMessage objects assigned to this IPrincipal or null if no messages are assigned. If the method is called with parameter true, every subsequent call will return null if no new message was assigned to this IPrincipal.

Parameters:

clearPermanentMessages - Specifies whether permanent messages with life time IMessage.LIFETIME_PERMANENT should be removed from the message buffer.

Returns:

The messages assigned to this IPrincipal object or null.

Access Rights

This class can be accessed from:

SC	DC
[sap.com] ENGINEAPI	[sap.com] com.sap.security.api.sda
[sap.com] ENGFACADE	[sap.com] tc/je/usermanagement/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib