http://www.ibm.com/schema/twss/spm/admin/requester/v2_0/interface
The RequesterAdministrationInterface Port Type

Requester administration interface. This interface allows an administrator to create, update, retrieve, and delete requester definitions. Retrieval functions allows for searching the requester hierarchy using a filter pattern and querying parent relationships for requesters in the hierarchy.

 Collapse Operations
RequesterAdministrationInterface_createRequestersResponse  createRequesters (createRequestersRequest request)

Attempts to create one or more requester definitions in a single batch operation. The runtime will iterate through the list of supplied requester definitions and attempt to create them in sequence. Faults will be returned for any failures encountered during iteration. Encountering failures does not necessarily halt the iteration, and the runtime may continue in best effort to create as many of the supplied definitions as possible.

Input: RequesterAdministrationInterface_createRequestersRequest

Create requesters operation input parameters. Contains a list of requester definitions to create in the service policy manager.

Output: RequesterAdministrationInterface_createRequestersResponse

Create requesters response result. This response contains a list of any faults that may have occurred while creating the supplied requester definitions.


RequesterAdministrationInterface_findMatchingRequestersResponse  findMatchingRequesters (findMatchingRequestersRequest request) [faults:  ServicePolicyException  ]

Finds a list of requester identifiers that match the supplied input parameters. An SQL92 'LIKE' clause pattern is supplied to filter requester identifier names. This can be used to limit the size of the output for a large number of requesters. In addition, the search can be limited to looking under a specified requester group definition or to searching for certain definition types (such as individual requesters only or requester groups only).

Input: RequesterAdministrationInterface_findMatchingRequestersRequest

Find matching requesters operation input parameters. Specifies the search criteria used to match requester identifiers. Search criteria include an SQL 'LIKE' clause matching parameter, a limit to search under a specified requester group, or limiting returned results to certain requester definition types. At a minimum, a pattern must be supplied, although a full wildcard can be used.

Output: RequesterAdministrationInterface_findMatchingRequestersResponse

Find matching requesters operation response result. Contains a list of matching requester definitions per the specified criteria.

Fault:
ServicePolicyException  : 

Raised if the specified pattern or requester definition type was invalid, or if an internal error occurred.


RequesterAdministrationInterface_getChildrenResponse  getChildren (getChildrenRequest request) [faults:  ServicePolicyException  ]

Gets all immediate child requester definitions of the specified requester group.

Input: RequesterAdministrationInterface_getChildrenRequest

Get children operation input parameters. Specifies the requester group whose children to return.

Output: RequesterAdministrationInterface_getChildrenResponse

Get children operation response result. Returns a list of requester definitions whose immediate parent is the input requester group.

Fault:
ServicePolicyException  : 

Raised if the specified requester group is invalid or does not exist, or if an internal error occurred.


RequesterAdministrationInterface_getParentChainResponse  getParentChain (getParentChainRequest request) [faults:  ServicePolicyException  ]

Returns the chain of requester group definitions for the specified requester identifier up to the root definition of the hierarchy. The chain is returned in a bottom up order, going up the hierarchy.

Input: RequesterAdministrationInterface_getParentChainRequest

Get parent chain operation input parameters. Specifies the requester identifier whose parent requster group chain to retrieve.

Output: RequesterAdministrationInterface_getParentChainResponse

Get parent chain operation response result. Returns a list of requester group definitions going up the chain from the specified requester identifier definition to the root requester group definition.

Fault:
ServicePolicyException  : 

Raised if the specified requester identifier is invalid or does not exist, or if an internal error occurs.


RequesterAdministrationInterface_getRequestersResponse  getRequesters (getRequestersRequest request) [faults:  ServicePolicyException  ]

Get requesters operation input parameters. Gets a list of requester definitions for each of the supplied requester identifiers. Requester identifiers may be individual requesters or requester groups.

Input: RequesterAdministrationInterface_getRequestersRequest

Get requesters operation input parameters. Contains a list of requester identifiers whose definitions to fetch.

Output: RequesterAdministrationInterface_getRequestersResponse

Get requesters operation response result. Contains a list of requester definitions, whose position in the array corresponds to the position of the input requester identifier array.

Fault:
ServicePolicyException  : 

Raised if a supplied requester identifier does not exist or an internal error occurs.


RequesterAdministrationInterface_removeRequestersResponse  removeRequesters (removeRequestersRequest request)

Removes one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the removal in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.

Note that removing a requester also removes the subscriptions associated with that requester, as well as any policies that have been defined in that requester's scope. Consider disabling the requester instead of removing the requester in order to preserve subscription and policy information associated with that requester.

Input: RequesterAdministrationInterface_removeRequestersRequest

Remove requesters operation input parameters. Contains a list of requester identifiers whose definitions to remove. Also indicates whether removal should prune children as well. If child nodes should not be removed and one of the specified requester identifiers has childeren, then an error will result.

Output: RequesterAdministrationInterface_removeRequestersResponse

Remove requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.


RequesterAdministrationInterface_resolveRequestersEnabledResponse  resolveRequestersEnabled (resolveRequestersEnabledRequest request) [faults:  ServicePolicyException  ]

Performs hierarchical resolution on a list of requester identifiers to determine their enablement status. A requester identifier may be disabled due to its entry being marked disabled, or some requester group higher in the hierarchy that has been disabled.

The enablement status of a requester is resolved going top down in the hierarchy. If one of the parent nodes in the chain is disabled, then that requster identifier is considered disabled. If all parents are enabled and the requester identifier itself is enabled, then the requester is considered enabled.

Input: RequesterAdministrationInterface_resolveRequestersEnabledRequest

Resolve requesters enabled operation input parameters. Contains a list of requester identifiers whose enablement status to resolve.

Output: RequesterAdministrationInterface_resolveRequestersEnabledResponse

Resolve requesters enabled operation response result. Contains a list of boolean flags indicating enablement status. The order of the results corresponds to the order of the input list of requesters.

Fault:
ServicePolicyException  : 

Raised if a supplied requester identifier is invalid or does not exist, or if an internal error occurred.


RequesterAdministrationInterface_updateRequestersResponse  updateRequesters (updateRequestersRequest request)

Updates one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the update in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.

Input: RequesterAdministrationInterface_updateRequestersRequest

Update requesters operation input parameters. Contains a list of requester definitions to update.

Output: RequesterAdministrationInterface_updateRequestersResponse

Update requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.


 Collapse XML
-<wsdl:portType  name="RequesterAdministrationInterface">
-<wsdl:documentation>
<xhtml:p>Requester administration interface. This interface allows an administrator to create, update, retrieve, and delete requester definitions. Retrieval functions allows for searching the requester hierarchy using a filter pattern and querying parent relationships for requesters in the hierarchy.</xhtml:p>
</wsdl:documentation>
-<wsdl:operation  name="createRequesters">
-<wsdl:documentation>
<xhtml:p>Attempts to create one or more requester definitions in a single batch operation. The runtime will iterate through the list of supplied requester definitions and attempt to create them in sequence. Faults will be returned for any failures encountered during iteration. Encountering failures does not necessarily halt the iteration, and the runtime may continue in best effort to create as many of the supplied definitions as possible.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Create requesters operation input parameters. Contains a list of requester definitions to create in the service policy manager.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Create requesters response result. This response contains a list of any faults that may have occurred while creating the supplied requester definitions.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
</wsdl:operation>
-<wsdl:operation  name="updateRequesters">
-<wsdl:documentation>
<xhtml:p>Updates one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the update in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Update requesters operation input parameters. Contains a list of requester definitions to update.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Update requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
</wsdl:operation>
-<wsdl:operation  name="getRequesters">
-<wsdl:documentation>
<xhtml:p>Get requesters operation input parameters. Gets a list of requester definitions for each of the supplied requester identifiers. Requester identifiers may be individual requesters or requester groups.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get requesters operation input parameters. Contains a list of requester identifiers whose definitions to fetch.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Get requesters operation response result. Contains a list of requester definitions, whose position in the array corresponds to the position of the input requester identifier array.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_req_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if a supplied requester identifier does not exist or an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="removeRequesters">
-<wsdl:documentation>
<xhtml:p>Removes one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the removal in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.</xhtml:p>
<xhtml:p>Note that removing a requester also removes the subscriptions associated with that requester, as well as any policies that have been defined in that requester's scope. Consider disabling the requester instead of removing the requester in order to preserve subscription and policy information associated with that requester.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Remove requesters operation input parameters. Contains a list of requester identifiers whose definitions to remove. Also indicates whether removal should prune children as well. If child nodes should not be removed and one of the specified requester identifiers has childeren, then an error will result.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Remove requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
</wsdl:operation>
-<wsdl:operation  name="resolveRequestersEnabled">
-<wsdl:documentation>
<xhtml:p>Performs hierarchical resolution on a list of requester identifiers to determine their enablement status. A requester identifier may be disabled due to its entry being marked disabled, or some requester group higher in the hierarchy that has been disabled.</xhtml:p>
<xhtml:p>The enablement status of a requester is resolved going top down in the hierarchy. If one of the parent nodes in the chain is disabled, then that requster identifier is considered disabled. If all parents are enabled and the requester identifier itself is enabled, then the requester is considered enabled.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Resolve requesters enabled operation input parameters. Contains a list of requester identifiers whose enablement status to resolve.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Resolve requesters enabled operation response result. Contains a list of boolean flags indicating enablement status. The order of the results corresponds to the order of the input list of requesters.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_req_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if a supplied requester identifier is invalid or does not exist, or if an internal error occurred.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="findMatchingRequesters">
-<wsdl:documentation>
<xhtml:p>Finds a list of requester identifiers that match the supplied input parameters. An SQL92 'LIKE' clause pattern is supplied to filter requester identifier names. This can be used to limit the size of the output for a large number of requesters. In addition, the search can be limited to looking under a specified requester group definition or to searching for certain definition types (such as individual requesters only or requester groups only).</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Find matching requesters operation input parameters. Specifies the search criteria used to match requester identifiers. Search criteria include an SQL 'LIKE' clause matching parameter, a limit to search under a specified requester group, or limiting returned results to certain requester definition types. At a minimum, a pattern must be supplied, although a full wildcard can be used.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Find matching requesters operation response result. Contains a list of matching requester definitions per the specified criteria.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_req_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the specified pattern or requester definition type was invalid, or if an internal error occurred.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="getChildren">
-<wsdl:documentation>
<xhtml:p>Gets all immediate child requester definitions of the specified requester group.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get children operation input parameters. Specifies the requester group whose children to return.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Get children operation response result. Returns a list of requester definitions whose immediate parent is the input requester group.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_req_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the specified requester group is invalid or does not exist, or if an internal error occurred.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="getParentChain">
-<wsdl:documentation>
<xhtml:p>Returns the chain of requester group definitions for the specified requester identifier up to the root definition of the hierarchy. The chain is returned in a bottom up order, going up the hierarchy.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get parent chain operation input parameters. Specifies the requester identifier whose parent requster group chain to retrieve.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Get parent chain operation response result. Returns a list of requester group definitions going up the chain from the specified requester identifier definition to the root requester group definition.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_req_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the specified requester identifier is invalid or does not exist, or if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
</wsdl:portType>
 Collapse Used-By
Service Port Binding
RequesterAdministrationService RequesterAdministrationService RequesterAdministrationInterfaceBinding
Generated by WSDLdoc ©