Actuate Information Delivery API operations : SelectUsers
 
SelectUsers
Searches users for specified information.
To search a single user, specify Name or Id. To search a list of users, specify NameList or IdList. To search users matching the specified conditions, specify Search.
Request schema
<xsd:complexType name="SelectUsers">
<xsd:sequence>
<xsd:element name="ResultDef" type="typens:ArrayOfString"/>
<xsd:choice minOccurs="0">
<xsd:element name="Search" type="typens:UserSearch"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="NameList" type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/>
<xsd:element name="Name" type="xsd:string"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
ResultDef
The properties to retrieve.
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectUsers allows only one search condition.
IdList
The list of user IDs to search. Specify either IdList or NameList.
NameList
The list of user names to search. Specify either NameList or IdList.
Id
The ID of the single user to search. Specify either Id or Name.
Name
The name of the single user to search. Specify either Name or Id.
Response schema
<xsd:complexType name="SelectUsersResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Users" type="typens:ArrayOfUser"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
Users
The selected users.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set. Not used when querying an Encyclopedia volume that uses Open Security. In this case, TotalCount returns Null. To retrieve the number of entries from an Encyclopedia volume that uses Open Security, use an array length. For example, the following code returns Null:
com.actuate.schemas.SelectUsersResponse userSrchResponse = proxy.selectUsers( userSel );
com.actuate.schemas.ArrayOfUser userArr = userSrchResponse.getUsers();
com.actuate.schemas.User []user = userArr.getUser();
userSrchResponse.getTotalCount();
int noOfUsers1 = userSrchResponse.getTotalCount().intValue();
The following code returns the correct value:
com.actuate.schemas.SelectUsersResponse userSrchResponse = proxy.selectUsers( userSel );
com.actuate.schemas.ArrayOfUser userArr = userSrchResponse.getUsers();
com.actuate.schemas.User []user = userArr.getUser();
userSrchResponse.getTotalCount();
int noOfUsers2 = user.length;