Cisco Cisco Prime Collaboration 10.5 用户指南
© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.
Page 50 of 2
Note: Using the ALL return criterion consumes a large portion of your CPU resources. It is recommended
that you use the KEYS_ONLY filter option to get the list of order IDs, and then do a getOrder to get details of a
specific order.
that you use the KEYS_ONLY filter option to get the list of order IDs, and then do a getOrder to get details of a
specific order.
• If there are orders in the system from a previous version of Prime Collaboration Provisioning, not all
the information will be returned, or the entire order may be skipped.
• If the device’s name is changed after the order is placed, the IM look up may fail. If this occurs, the
order is skipped.
Syntax:
public ResponseReturn listOrder (CUPMServiceStub stub, CupmApiFilterValue filter, String
endPointReference, String ipPre);
endPointReference, String ipPre);
Parameters:
• filter—Used to further narrow the selection criteria.
You can filter using the following attributes:
o
SubscriberID
o
ServiceAreaID
o
DomainID
o
ProductID
o
OrderStatus
• 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.
generated numeric.
Returns:
CupmApiResponseValue—Object with NBI ID.
Throws:
ListOrderException—If server cannot execute 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. If the NBI order request is still retained, it will be returned. If its retention time is
exceeded and it has been purged, a translation of the XMLEntity version of the work order object is
returned. If a filter that is set to KEYS_ONLY is provided, the CupmApiList will contain xmlstrings.
Each string will contain one Object ID.
suggested standards. If the NBI order request is still retained, it will be returned. If its retention time is
exceeded and it has been purged, a translation of the XMLEntity version of the work order object is
returned. If a filter that is set to KEYS_ONLY is provided, the CupmApiList will contain xmlstrings.
Each string will contain one Object ID.
• CupmApiFaultType—Included if the NBI request fails.
Note: The pullOp API can be used to retrieve a list of elements according to a specified enumeration context
(for more information on pullOp, see
(for more information on pullOp, see
pullOp Java Signature.