Cisco Cisco Prime Collaboration 10.6 Developer's Guide

Page 61 of 82

public ResponseReturn listConfigTemplateKeyword (CUPMServiceStub stub String templateName, String

endPointReference, String idPrefix);

Parameters:



templateName

—Name identifying the template for which to return the list of keywords.



endPointReference

—String to convert to an EndpointReference object that the asynchronous result

notification will be sent to.



idPrefix

—String that is added to the beginning of the internally generated numeric to form the NBI ID. Null

or empty string valid for no change to internal generation.

Returns:

CupmApiResponseValue

—Object with NBI ID.

Throws:

listConfigTemplateException

—If server cannot execute NBI request.

ASyncReturn:



CupmApiResultValue

—Contains CupmApiStatus and CupmApiList. CupmApiList contains one object that

lists the keywords in this template. That object is a KeywordListDocument containing an ArrayOfString

object.



CupmApiFaultType

—Included if the NBI request fails.

WS-Enumeration Requests

When a Prime Collaboration Provisioning NBI List Command is executed successfully, a CupmApiResultValue is

sent as a notification to the client. This notification contains the object wsen:EnumerationContext. The client can

now send the following requests to the server while referencing this EnumerationContext:



PullOp

—Returns a list of elements according to a specified enumeration context. It may also return an

updated enumeration context, which the caller should use for all future requests.



RenewOp

—Renews the expiration time for a specified enumeration context as long as the context is still

valid. This operation will fail and generate a fault if the context is invalid.



GetAPIStatus

—Returns the status of an enumeration context, such as the expiration time.



ReleaseOp

—Invalidates a specified enumeration context and releases any resources allocated to

theenumeration. The UUID list generated by the Prime Collaboration Provisioning NBI List command is

flagged for deletion.

Note: The objects used in the Java code can be imported from org.xmlsoap.schemas.ws.x2005.x09.enumeration.