com.ibm.itim.remoteservices.provider
Interface SearchResults


public interface SearchResults

Encapsulates search results from a remote resource. Should be implemented by service provider to iterate over the results returned when reconciling a remote resource. Optionally, may be used to facilitate lazy loading from the remote resource to adapt commonly used API's for directories and relational databases. If close() method is called on the search results, the connection with the remote resource should be dropped. This may be called when the user wishes to abort a search before completing it. Each entry in the search results consists of a SearchResult.

See Also:
SearchResult

Method Summary
 void close()
          Closes the connection with the remote resource.
 RequestStatus getRequestStatus()
          Gets the status of the search request.
 boolean hasNext()
          True if there is another element to be iterated over
 SearchResult next()
          The next value in the sequence
 

Method Detail

getRequestStatus

public RequestStatus getRequestStatus()
Gets the status of the search request. Should contain a warning message if not successful or if successful with a warning.

Returns:
The status of the search request

hasNext

public boolean hasNext()
                throws RemoteServicesException
True if there is another element to be iterated over

Returns:
Whether there are more elements
Throws:
RemoteServicesException - if there was a problem while attempting to determine if there is a next element

next

public SearchResult next()
                  throws RemoteServicesException
The next value in the sequence

Returns:
The next entry in the sequence
Throws:
RemoteServicesException - if there was a problem obtaining the next element

close

public void close()
           throws RemoteServicesException
Closes the connection with the remote resource. May be called during a search for early termination of the search.

Throws:
RemoteServicesException - if the search results were not able to be closed


IBM Tivoli Identity Manager 4.6
© Copyright International Business Machines Corporation 2005. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.