Actuate Information Delivery API data types : ChannelSearch
 
ChannelSearch
A complex data type that represents a channel search.
Schema
<xsd:complexType name="ChannelSearch">
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="Condition"
type="typens:ChannelCondition"/>
<xsd:element name="ConditionArray"
type="typens:ArrayOfChannelCondition"/>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:element name="SubscribedUserId" type="xsd:string"/>
<xsd:element name="SubscribedUserName" type="xsd:string"/>
<xsd:element name="PrivilegeFilter"
type="typens:PrivilegeFilter">
</xsd:element>
</xsd:choice>
<xsd:element name="IncludeInheritedPrivilege"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="FetchSize" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchDirection" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="CountLimit" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Elements
Condition
The search condition.
ConditionArray
An array of search conditions.
SubscribedUserId
The ID of the user subscribed to the channel.
SubscribedUserName
The name of the user subscribed to the channel.
PrivilegeFilter
The privileges for which to search. Use PrivilegeFilter to determine the channels to which the specified user or role has the specified privileges.
IncludeInheritedPrivilege
Specifies whether to search only the privileges directly assigned to the channel or to include inherited privileges.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.