Cisco Cisco Prime Collaboration 10.6 User Guide

Page 52 of 2

ASyncReturn:

• CupmApiResultValue—Contains CupmApiStatus and CupmApiList. The CupmApiList contains the one

InventoryItem object selected.

• CupmApiFaultType—Included if the NBI request fails.

listInventoryItem Java Signature

Retrieves a list of inventory items from the Prime Collaboration Provisioning database, based on the filter selection.

Note that the filter can also select based on associated objects (one level of association only).

Syntax:

public ResponseReturn listInventoryItem (CUPMServiceStub stub, CupmApiFilterValue filter, String

endPointReference, String idPrefix);

Parameters:

• filter—Specifies which InventoryItem objects to return and which attributes to include.

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

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);