unspRXCustomerMgr.idl
The following IDL is the definition of unspRXCustomerMgr.idl:
#ifndef unspRXCustomerMgr_idl#define unspRXCustomerMgr_idl// ********************************// * *// * unspRXCustomerMgr.idl *// * *// ********************************//Include list#include "globaldefs.idl"#include "common.idl"#pragma prefix "nmcrx.unspcorbabridge.provisioningservice.services.redstonecom.com"module unspRXCustomerMgr{/*** UnspRXCustomerMgrObjectType defined all possible object types for NMC-RX to manage*/enum UnspRXCustomerMgrObjectType{// Layered Objects // Examples:EMS, // "Juniper NMC-RX"Customer, // "ABC Store Customer"CustSite // "Westford Customer Site"};/*** UnspRXCustomerMgrObjectTypeList is a list UnspRXCustomerMgrObjectType*/typedef sequence<UnspRXCustomerMgrObjectType> UnspRXCustomerMgrObjectTypeList;/*** UnspRXActionType defined all possible action types* for NMC-RX to manage ERX/MRX*/enum UnspRXCustomerActionType{LIST,VIEW};/*** UnspRXActionTypeList is a list UnspRXActionType*/typedef sequence<UnspRXCustomerActionType> UnspRXCustomerActionTypeList;/*** UnspRXCustomerMgr_I defines all methods to manage objects* under ERX/MRX. It is derived from common::Common_I, which is* one of the idls defined by TMF 814.*/interface UnspRXCustomerMgr_I : common::Common_I{/*** This method should be used to list all objects of a particular type relative* to another object.** The retrieval mechanism follows the paradigm established in TMF 814* and is described below:** objectPath: The name-value pair list of objects you want to list relative to another object.* Example:* ListAll Customer relative to objectPath* Name="EMS", Value="Juniper NMC-RX"** ListAll Customer Site relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="Customer", Value="ABC Store Customer"** objectType: The type of objects that you want to list* Example:* UnspRXCustomerMgrObjectType.Customer* UnspRXCustomerMgrObjectType.CustSite** howMany: The maximum number of objects to report in the first batch in nameList** nameList: First batch of howMany objects report to NMS** nameIt: Iterator to retrieve the remaining number of objects after the first batch* In order to allow the NMS to deal more easily with retrievals, which may return a* very large amount of data, iterators are used. They provide a mechanism to retrieve* data batch by batch - the size of a batch is specified by the NMS via the* how_many parameter in the next_n method of the iterator reference.* For a more detailed explanation of the use of iterators, please refer to* TMF814\supportingDocumentation\iterators.html* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void listAll(in globaldefs::NVSList_T objectPath,in UnspRXCustomerMgrObjectType objectType,in long howMany,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);/*** This method should be used to view objects** objectPath: The name-value pair list of the object you want to configure.* Example:* View Customer Site relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="Customer", Value="ABC Store Customer"* Name="CustSite", Value="Westford Customer Site"** attributesList: It will hold all attributes as a name-value pair list* to pass back to NMS to view this object.* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void view(in globaldefs::NVSList_T objectPath,out globaldefs::NVSList_T attributesList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get a list of object types on which you can perform list* actions relative to other objects.** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"** objectTypeList: To hold a list of object types** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getListableObjectTypeSelections(in globaldefs::NVSList_T objectPath,out UnspRXCustomerMgrObjectTypeList objectTypeList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get a list of types of action that you can perform* relative to other objects.** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"** objectTypeList: To hold a list of action types** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getSupportedActions(in globaldefs::NVSList_T objectPath,out UnspRXCustomerActionTypeList actionTypeList)raises(globaldefs::ProcessingFailureException);};};#endifProvisioning Objects
The following sections describe the provisioning objects for this IDL.
Customer
Customer Site