findUserIds

Returns the list of user IDs for those users that match the supplied criteria. This method performs searches where the search result set size is known to be small by the caller. If the result set is large or unknown, consider using:

Copy 
findUsersInit(Criteria[ ])/findUserIdsFetch(String, boolean, or int)

For Java:

Copy 
UserId[] findUserIds(Criteria[] criteria, int maxItems) 
throws ManagementException, SessionException, LocalizedRemoteException;

Parameters:

  • criteria—List of search criteria with which to filter. This parameter can take the same values as the criteria parameter of findUsers.

  • maxItems—Maximum number of items to fetch if the search exceeds this number. If there is no limit, you can set this parameter to 0 (zero) or to a negative number. If, as the result of an LDAP search (such as findUser), the number of results matching the query exceeds the maxItems specified, this causes an exception to be thrown— SizeLimitPeopleException. For more information, refer to the JDK documentation:

    • http://docs.oracle.com/javase/jndi/tutorial/basics/directory/countlimit.html

When this occurs, to receive a result set you must increase the value of maxItems or make your query more specific. Also note that the CCM API times out after 60 seconds if the query is taking too long.

Returns:

  • List of identifiers of users matching the supplied criteria.

Exceptions:

  • SessionException— if there is no valid session (such as session not opened or timed out).

  • ManagementException— if an internal failure occurs.

  • LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.