Skip navigation links

oracle.security.idm
Interface SearchResponse

public interface SearchResponse

This interface represents search results obtained after searching from identity store. Its implementation is service provider specific.

Since:

10.1.3

Method Summary

void	close() Closes this response object and frees all resources associated with it.
int	getResultCount() Returns the total result count.
boolean	hasNext() Determines if further results are available.
Identity	next() Returns the next result in the response

Method Detail

getResultCount

int getResultCount()
                   throws IMException

Returns the total result count.

Returns:

int total result count. -1 if if the provider or the underlying repository doesn't support this feature.

Throws:

IMException

close

void close()
           throws IMException

Closes this response object and frees all resources associated with it. After close() is called the response object becomes invalid. Any subsequent invocation of its methods will yeild undefined results. Close() should be invoked when discarding a response object so that resources are freed. If a response proceeds to its natural end (i.e. when hasMore() returns false) then close() will be called internally. There is no need to call close() explicitly in such case.

Throws:

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

hasNext

boolean hasNext()
                throws IMException

Determines if further results are available.

Returns:

boolean true if more results are available; else false.

Throws:

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

next

Identity next()
              throws IMException

Returns the next result in the response

Returns:

Identity next result in response.

Throws:

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

Skip navigation links