Cisco Cisco Prime Collaboration 10.6 User Guide

Page 59 of 2

• 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.

pullOp Java Signature

The pullOp command retrieves a portion of the list data generated by any list NBI. The client may set the

MaxElements attribute in the CupmApiEnumIterator before sending to specify the number of elements returned.

The default is 1. The pullOp command will never return more than this amount. It may return less if some objects

have been deleted since the report was generated, or if there was an error. Subsequent calls to pull will return the

next sequence of elements in the data.

Syntax:

public ResponseReturn pullOp (CUPMServiceStub stub, wsen:EnumerationContext, wsen:MaxElements, pullSize);

Parameters:

• wsen:EnumerationContext—The latest version of this object that the client has received from the server.

• wsen:MaxElements, pullSize—The number of objects to return with this request.

Returns:

Standard Pull response.

Throws:

• RemoteExcepton—If the server cannot execute the NBI request.

SyncReturn:

The standard pull response, which contains an ItemArrayType. In that type is the number of objects requested. If

the pull reached the end of the list, a wsen:EndOfSequence object is returned as a peer of the list. This indicates to

the client that no more elements are available and that the enumeration context is now invalid. The client should

not invoke additional pull operations or invoke the Release operation to signal that the enumeration context is no

longer needed. Doing so will result in a wsen:InvalidEnumerationContext fault.

CupmApiFaultType—Included if the NBI request fails.

renewOp Java Signature

The renewOp command tells the server that the client wants to keep the data longer than the initial expiration date.

The Prime Collaboration Provisioning server will allow this to happen only if the throttling thresholds for reports will

not be exceeded by the renewal.

Syntax: