Cisco Cisco Prime Collaboration 10.5 Developer's Guide

• 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 unique NBI

identifier. A null or empty string is valid, resulting in an NBI identifier that is just the internally generated

numeric.

• offset—String to specify the index starting from which the inventory items have to be fetched.

• numberOfItems—String to specify the number of items to be retrieved in the response

• responseType (optional)— String to identify whether the API call should be synchronous or not.

Returns:

CupmApiResponseValue—Object with NBI ID.

Throws:

ListInventoryItemException—If the server cannot execute the NBI request.

ASyncReturn:

CupmApiResultValue—Contains CupmApiStatus and CupmApiList. CupmApiList contains one object, the

EnumerationContextType, which is used to retrieve the list using WS-Enumeration suggested standards.

CupmApiFaultType—Included if the NBI request fails.

Prepopulation

Prepopulation in this context refers to populating a service attribute choice list dynamically.

listProductAttributeChoice Java Signature

Returns a choice list for a specific attribute for a specific product. The choice list is dynamic, based on the

Capabilityname, DeviceName, ServiceAreaID, and product attributes that have already been specified.

Syntax:

public ResponseReturn listProductAttributeChoice (CUPMServiceStub stub, String[] arrayOfAttributes,

ProductValue product, CupmApiFilterValue filter, String endPointReference, String idPrefix);

Parameters:

• product—The product specified for the return choice list, containing all attributes that have already been

set.

• arrayOfAttributes—Each attribute for which a choice list will be returned.

• filter—The selection criteria section of the filter specifies the device, the capability of the device, the

ServiceArea, and any product attribute values that have been set. You must specify capabilityName and

either DeviceName or ServiceAreaID or both.