8a.3 Interface Classes

29.198-033GPPOpen Service Access (OSA) Application Programming Interface (API)Part 3: FrameworkTS

8a.3.1 Event Notification Interface Classes

8a.3.1.1 Interface Class IpClientEventNotification

Inherits from: IpInterface.

This interface is used by the framework to inform the client of a generic event. The Event Notification Framework will invoke methods on the Event Notification Client Interface that is specified when the Event Notification interface is obtained.

<<Interface>>

IpClientEventNotification

reportNotification (eventInfo : in TpFwEventInfo, assignmentID : in TpAssignmentID) : void

notificationTerminated () : void

8a.3.1.1.1 Method reportNotification()

This method notifies the client of the arrival of a generic event.

Parameters

eventInfo : in TpFwEventInfo

Specifies specific data associated with this event.

assignmentID : in TpAssignmentID

Specifies the assignment id which was returned by the framework during the createNotification() method. The client can use assignment id to associate events with event specific criteria and to act accordingly.

8a.3.1.1.2 Method notificationTerminated()

This method indicates to the client that all generic event notifications have been terminated (for example, due to faults detected).

Parameters

No Parameters were identified for this method.

8a.3.1.2 Interface Class IpEventNotification

Inherits from: IpInterface.

The event notification mechanism is used to notify the client of generic events that have occurred. If Event Notifications are supported by a Framework, this interface and the createNotification() and destroyNotification() methods shall be supported.

<<Interface>>

IpEventNotification

createNotification (eventCriteria : in TpFwEventCriteria) : TpAssignmentID

destroyNotification (assignmentID : in TpAssignmentID) : void

8a.3.1.2.1 Method createNotification()

This method is used to enable generic notifications so that events can be sent to the client.

Returns <assignmentID>: Specifies the ID assigned by the framework for this newly installed notification.

Parameters

eventCriteria : in TpFwEventCriteria

Specifies the event specific criteria used by the client to define the event required.

Returns

TpAssignmentID

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE

8a.3.1.2.2 Method destroyNotification()

This method is used by the client to delete generic notifications from the framework.

Parameters

assignmentID : in TpAssignmentID

Specifies the assignment ID given by the framework when the previous createNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the framework will return the error code P_INVALID_ASSIGNMENT_ID.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_ASSIGNMENT_ID

8a.3.2 Service Subscription Interface Classes

8a.3.2.1 Interface Class IpClientAppManagement

Inherits from: IpInterface.

If the enterprise operator wants the client applications in its domain to access the subscribed services in name of the enterprise, then (s)he has to register these client applications in the Framework domain. For this the enterprise operator must use the client application management interface, to which (s)he can subscribe as a privileged user. The client application management interface is intended for cases where an organisation wants to allow several client applications to register with a Framework as service consumers. It allows enterprise operators to dynamically add new client applications and SAGs, delete them and to modify subscription related information concerning the client applications and the SAGs. Client applications use the subscribed services in the enterprise operator’s name. The main task of client application management is to register, modify and delete client applications (Client Application Management), and manage groups of client applications, called Subscription Assignment Groups (SAG Management).

<<Interface>>

IpClientAppManagement

createClientApp (clientAppDescription : in TpClientAppDescription) : void

modifyClientApp (clientAppDescription : in TpClientAppDescription) : void

deleteClientApp (clientAppID : in TpClientAppID) : void

createSAG (sag : in TpSag, clientAppIDs : in TpClientAppIDList) : void

modifySAG (sag : in TpSag) : void

deleteSAG (sagID : in TpSagID) : void

addSAGMembers (sagID : in TpSagID, clientAppIDs : in TpClientAppIDList) : void

removeSAGMembers (sagID : in TpSagID, clientAppIDList : in TpClientAppIDList) : void

requestConflictInfo () : TpAddSagMembersConflictList

8a.3.2.1.1 Method createClientApp()

A client application is represented in the Framework domain as a "clientApp object". This method creates a new clientApp object associated with the enterprise operator object. Each clientApp object has a clientApp ID and other subscription related client application’s properties stored in it.

Parameters

clientAppDescription : in TpClientAppDescription

The "clientAppDescription" parameter contains the clientApp ID that is to be associated with the newly created clientApp object and the subscription‑related "client application properties". The clientApp ID must be a unique ID across framework, if the ID already exists, an exception "P_INVALID_CLIENT_APP_ID" would be raised. The client application properties are a list of name/value pairs. The client application properties are an item for bi‑lateral agreement between the enterprise operator and the framework operator.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID

8a.3.2.1.2 Method modifyClientApp()

Modify the information contained in an existing clientApp object associated with the enterprise operator. An exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

clientAppDescription : in TpClientAppDescription

The "clientAppDescription" parameter contains the modified client application information. If the clientApp ID does not exist, an exception "P_INVALID_CLIENT_APP_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID

8a.3.2.1.3 Method deleteClientApp()

Delete the specified client application associated with the enterprise operator. If the client application currently has an access session with the framework then this will be terminated, along with any service instances it may have created. An exception of "P_TASK_REFUSED" will be raised if a non‑associated enterprise operator invokes this method.

Parameters

clientAppID : in TpClientAppID

The "clientAppID" parameter identifies the client application that is to be deleted. If the clientAppID does not exist, a "P_INVALID_CLIENT_APP_ID" exception will be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID

8a.3.2.1.4 Method createSAG()

Create a new SAG associated with the enterprise operator. The SAG object is identified by a SAG ‑ ID and contains SAG ‑ specific description.

Parameters

sag : in TpSag

The "sag" parameter contains the SAG‑ID and SAG‑specific description. This sagID is particular to the SAG, and must be unique across framework. If the sagID supplied already exists, an exception of type "P_INVALID_SAG_ID" would be raised.

clientAppIDs : in TpClientAppIDList

The "clientAppIDs" parameter contains the list of client application IDs that are to be associated with the newly created SAG.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID, P_INVALID_SAG_ID

8a.3.2.1.5 Method modifySAG()

Modify the description of an existing SAG associated with the enterprise operator. An exception of "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

sag : in TpSag

The "sag" parameter contains the modified SAG‑specific description. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID

8a.3.2.1.6 Method deleteSAG()

Delete an existing SAG. Only the enterprise operator associated with the SAG is allowed to delete it, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG that is to be deleted. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" is raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID

8a.3.2.1.7 Method addSAGMembers()

Add the specified client applications to the specified SAG associated with the enterprise operator. Only the enterprise operator associated with the SAG is allowed to assign members to it, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method. Each client application may be assigned to a service only through a single service profile at a particular moment in time. If this condition is violated, a "P_INVALID_ADDITION_TO_SAG" would be raised. In this case, no partial execution of this method is performed. The enterprise operator can query further information about this invalid addition using the method requestConflictInfo().

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG object to which the client applications are to be added. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" would be raised.

clientAppIDs : in TpClientAppIDList

The "clientAppIDs" parameter contains the list of the clientApp IDs that are to be added to the specified SAG. The clientApp objects are first created using the createClientApp() method. If one or all of the client application IDs in the list does not exist, an exception "P_INVALID_CLIENT_APP_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID, P_INVALID_SAG_ID, P_INVALID_ADDITION_TO_SAG

8a.3.2.1.8 Method removeSAGMembers()

Delete specified client applications from the specified SAG object of the enterprise operator. Only the enterprise operator associated with the SAG is allowed to remove members from it, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG from which the client applications are to be removed. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" would be raised.

clientAppIDList : in TpClientAppIDList

The "clientAppIDList" parameter contains the list of the clientApp IDs that are to be removed from the specified SAG. If one or all of the client application IDs in the list does not exist, an exception "P_INVALID_CLIENT_APP_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID, P_INVALID_SAG_ID

8a.3.2.1.9 Method requestConflictInfo()

Requests details about the latest conflict that occurred during performing the method addSagMembers() on this interface (i.e. Information about the invocation of addSagMembers() that raised a P_INVALID_ADDITION_TO_SAG). Each client application may be assigned to a service only through a single service profile at a particular moment in time. The enterprise operator might try to add a client application to a SAG, where both, the client application and the SAG are already assigned to the same service through different service profiles. As this may happen in one method call for multiple client applications, a conflict list is generated.

It is only possible to retrieve information about the last conflicting addSagMembers() method call; information about previous conflicts cannot be requested. If there has never been a conflict, the method returns an empty conflict list.

Returns <TpAddSagMembersConflictList>: The list of conflicts of the last invocation of addSagMembers() that raised a P_INVALID_ADDITION_TO_SAG. Each conflict contains the following elements:

a. The conflict generating client application. b. The SAG and the service profile through which the conflict generating client application is already assigned to the conflict generating service. It includes the current service profile. c. The SAG, to which the conflict generating client application should be added. However, this SAG is already assigned to a concurrent service profile concerning the conflict generating service. This creates a conflict, as each client application may be assigned to a service only through a single service profile at a particular moment in time. d. The conflict generating service.

Parameters

No Parameters were identified for this method.

Returns

TpAddSagMembersConflictList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.2 Interface Class IpClientAppInfoQuery

Inherits from: IpInterface.

This interface is used by the enterprise operator to list the client applications and the SAGs in its domain and to obtain information about them.

<<Interface>>

IpClientAppInfoQuery

describeClientApp (clientAppID : in TpClientAppID) : TpClientAppDescription

listClientApps () : TpClientAppIDList

describeSAG (sagID : in TpSagID) : TpSagDescription

listSAGs () : TpSagIDList

listSAGMembers (sagID : in TpSagID) : TpClientAppIDList

listClientAppMembership (clientAppID : in TpClientAppID) : TpSagIDList

8a.3.2.2.1 Method describeClientApp()

Query information about the specified client application of the enterprise operator.

Returns <clientAppDescription>: The "clientAppDescription" parameter contains the clientApp description.

Parameters

clientAppID : in TpClientAppID

The "clientAppID" parameter identifies the clientApp object whose description is requested.

Returns

TpClientAppDescription

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID

8a.3.2.2.2 Method listClientApps()

Get a list of all client applications belonging to an enterprise operator.

Returns <clientAppIDs>: The "clientAppIDs" parameter identifies the list of client applications in the enterprise operator domain.

Parameters

No Parameters were identified for this method.

Returns

TpClientAppIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.2.3 Method describeSAG()

Query information about the specified SAG associated with the enterprise operator.

Returns <SagDescription>: The "sagDescription" parameter returns the SAG‑specific description.

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG whose description is required.

Returns

TpSagDescription

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID

8a.3.2.2.4 Method listSAGs()

Get a list of all SAGs associated with an enterprise operator.

Returns <SagIDList>: The "sagIDList" parameter returns the list of the identifiers of the SAGs associated with the enterprise operator.

Parameters

No Parameters were identified for this method.

Returns

TpSagIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.2.5 Method listSAGMembers()

Get a list of all client applications associated with the specified SAG.

Returns <clientAppIDList>: The "clientAppIDList" parameter returns the list of the client applications associated with the SAG.

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG whose clientAppID list is required.

Returns

TpClientAppIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID

8a.3.2.2.6 Method listClientAppMembership()

Obtain a list of the SAGs of which the specified client application is a member.

Returns <sags>: The SAGs of which the client application is a member.

Parameters

clientAppID : in TpClientAppID

The "clientAppID" parameter identifies the clientApp object whose membership details are requested.

Returns

TpSagIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_CLIENT_APP_ID

8a.3.2.3 Interface Class IpServiceProfileManagement

Inherits from: IpInterface.

This interface is used by the enterprise operator for the management of Service Profiles, which are defined for every subscribed service, and to assign/de ‑ assign the Service Profiles to SAGs.

<<Interface>>

IpServiceProfileManagement

createServiceProfile (serviceProfileDescription : in TpServiceProfileDescription) : TpServiceProfileID

modifyServiceProfile (serviceProfile : in TpServiceProfile) : void

deleteServiceProfile (serviceProfileID : in TpServiceProfileID) : void

assign (sagID : in TpSagID, serviceProfileID : in TpServiceProfileID) : void

deassign (sagID : in TpSagID, serviceProfileID : in TpServiceProfileID) : void

requestConflictInfo () : TpAssignSagToServiceProfileConflictList

8a.3.2.3.1 Method createServiceProfile()

Creates a new Service Profile for the specified service contract. The service properties within the service profile restrict the service to meet the client application requirements. A Service Profile is a restriction of the corresponding service contract. When the description has been verified, a service profile ID will be generated.

Returns <serviceProfileID>: The service profile ID, generated by the framework, will be used to uniquely identify the service profile within the framework.

Parameters

serviceProfileDescription : in TpServiceProfileDescription

The "serviceProfile" parameter is a structured data type, which contains a subset of the associated service contract information and which may further restrict the value ranges of the service subscription properties.

Returns

TpServiceProfileID

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.3.2 Method modifyServiceProfile()

Modifies the specified Service Profile associated with the enterprise operator. Only the enterprise operator associated with the particular service profile is allowed to modify it, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

serviceProfile : in TpServiceProfile

The modified Service Profile. If the serviceProfileID specified in the serviceProfile parameter does not exist, an exception "P_INVALID_SERVICE_PROFILE_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_PROFILE_ID

8a.3.2.3.3 Method deleteServiceProfile()

Deletes the specified Service Profile. If there are any service instances running that are governed by this profile then they will be terminated. Only the enterprise operator associated with the particular service profile is allowed to delete it, a "P_TASK_REFUSED" exception will be raised if a non‑associated enterprise operator invokes this method.

Parameters

serviceProfileID : in TpServiceProfileID

The "serviceProfileID" parameter identifies the Service Profile that is to be deleted. If the serviceProfileID does not exist, a "P_INVALID_SERVICE_PROFILE_ID" exception will be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_PROFILE_ID

8a.3.2.3.4 Method assign()

Assign a Service Profile to the specified SAG. Only the enterprise operator associated with the serviceProfileID is allowed to assign it to a SAG, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method. Each client application may be assigned to a service only through a single service profile at a particular moment in time. If this condition is violated, a "P_INVALID_SAG_TO_SERVICE_PROFILE_ASSIGNMENT" would be raised. In this case, no partial execution of this method is performed. The enterprise operator can query further information about this invalid assignment using the method requestConflictInfo().

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG to which Service Profile is to be assigned. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" would be raised.

serviceProfileID : in TpServiceProfileID

The "serviceProfileID" parameter identifies the Service Profile that is to be assigned to the SAG. If the serviceProfileID does not exist, an exception "P_INVALID_SERVICE_PROFILE_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID, P_INVALID_SERVICE_PROFILE_ID, P_INVALID_SAG_TO_SERVICE_PROFILE_ASSIGNMENT

8a.3.2.3.5 Method deassign()

De‑assign the Service Profile from the specified SAG. Because only the enterprise operator associated with the serviceProfileID is allowed to deassign it from a SAG, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

sagID : in TpSagID

The "sagID" parameter identifies the SAG whose Service Profile is to be de‑assigned. If the SAG ID does not exist, an exception "P_INVALID_SAG_ID" would be raised.

serviceProfileID : in TpServiceProfileID

The "serviceProfileID" parameter identifies the Service Profile that is to be de‑assigned. If the serviceProfileID does not exist, an exception "P_INVALID_SERVICE_PROFILE_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SAG_ID, P_INVALID_SERVICE_PROFILE_ID

8a.3.2.3.6 Method requestConflictInfo()

Requests details about the latest conflict that occurred during performing the method assign() on this interface (i.e. Information about the invocation of assign () that threw a P_INVALID_SAG_TO_SERVICE_PROFILE_ASSIGNMENT). Each client application may be assigned to a service only through a single service profile at a particular moment in time. The enterprise operator could try to assign a SAG to a service profile of a given service. If one or more client applications in this SAG are already assigned to service profiles belonging to the given service, the client applications would have two concurrent service profiles at a particular moment in time. As this is prohibited, a conflict list is generated.

It is only possible to retrieve information about the last conflicting assign() method call; information about previous conflicts cannot be requested. If there has never been a conflict, the method returns an empty conflict list.

Returns <TpAssignSagToServiceProfileConflictList>: The description of the conflicts occurring at the latest invocation of assign() that raised a P_INVALID_SAG_TO_SERVICE_PROFILE_ASSIGNMENT. Each conflict contains the following elements:

a. The conflict generating client application. b. The SAG and the service profile through which the conflict generating client application is already assigned to the conflict generating service. It includes the current service profile. c. The conflict generating service.

The conflict generating SAG and service profile are supposed to be well known, because they are input parameters of the assign() method. Therefore, they do not appear in the returned conflict list.

Parameters

No Parameters were identified for this method.

Returns

TpAssignSagToServiceProfileConflictList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.4 Interface Class IpServiceProfileInfoQuery

Inherits from: IpInterface.

This interface is used by the enterprise operator to obtain information about individual Service Profiles, to find out which SAGs are assigned to a given Service Profile, and to find out what Service Profile is associated with a given client application or SAG.

<<Interface>>

IpServiceProfileInfoQuery

listServiceProfiles () : TpServiceProfileIDList

describeServiceProfile (serviceProfileID : in TpServiceProfileID) : TpServiceProfileDescription

listAssignedMembers (serviceProfileID : in TpServiceProfileID) : TpSagIDList

8a.3.2.4.1 Method listServiceProfiles()

Get a list of all service profiles created by the enterprise operator.

Returns <serviceProfileIDList>: The "serviceProfileIDList" is a list of the service profiles associated with the enterprise operator.

Parameters

No Parameters were identified for this method.

Returns

TpServiceProfileIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.4.2 Method describeServiceProfile()

Query information about a single service profile.

Returns <serviceProfileDescription>: The "serviceProfileDescription" parameter is a structured data type which contains a description for the specified service profile.

Parameters

serviceProfileID : in TpServiceProfileID

The "serviceProfileID" parameter identifies the Service Profile whose description is being requested.

Returns

TpServiceProfileDescription

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_PROFILE_ID

8a.3.2.4.3 Method listAssignedMembers()

Get a list of SAGs assigned to the specified service profile.

Returns <sagIDList>: The "sagIDs" parameter is the list of the SAG IDs that are assigned to the specified service profile.

Parameters

serviceProfileID : in TpServiceProfileID

The "serviceProfileID" parameter identifies the Service Profile. If the serviceProfileID is not recognised by the framework, an exception "P_INVALID_SERVICE_PROFILE_ID" would be raised.

Returns

TpSagIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_PROFILE_ID

8a.3.2.5 Interface Class IpServiceContractManagement

Inherits from: IpInterface.

The enterprise operator uses this interface for service contract management, such as create, modify, and delete service contracts.

<<Interface>>

IpServiceContractManagement

createServiceContract (serviceContractDescription : in TpServiceContractDescription) : TpServiceContractID

modifyServiceContract (serviceContract : in TpServiceContract) : void

deleteServiceContract (serviceContractID : in TpServiceContractID) : void

8a.3.2.5.1 Method createServiceContract()

Create a new service contract for an enterprise operator. The enterprise operator provides the service contract description. This contract should conform to the previously negotiated high ‑ level agreement (regarding the services, their usage and the price, etc.), if any, between the enterprise operator and the framework operator, otherwise the appropriate exception is raised by the framework. When the description has been validated, a service contract ID will be generated.

Returns <serviceContractID>: The service contract ID will be used to uniquely identify the service contract within the framework.

Parameters

serviceContractDescription : in TpServiceContractDescription

The "serviceContractDescription" parameter provides the information contained in the service contract. The service contract is a structured data type, which contains the following information: a. information about the service requestor, i.e. the enterprise operator; b. information about the billing contact (person); c. service start date; d. service end date; e. service type (e.g. obtained from listServiceType() method); f. service ID (e.g. obtained from discoverService() method). For certain services, service type information is sufficient and service ID may not be required. This implies that any service of the type specified above is subscribed and hence accessible to the enterprise operator or to its client applications; g. list of service subscription properties and their value ranges (service profiles further restrict these value ranges).

Returns

TpServiceContractID

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_ID

8a.3.2.5.2 Method modifyServiceContract()

Modify an existing service contract. The service contract can be modified only within the context of a pre‑existing off‑line negotiated high‑level agreement between the enterprise operator and the framework operator. Only the enterprise operator associated with the serviceContract is allowed to modify it, an exception "P_TASK_REFUSED" would be raised if a non‑associated enterprise operator invokes this method.

Parameters

serviceContract : in TpServiceContract

The "serviceContract" parameter provides the modified service contract. If the serviceContractID does not exist, an exception "P_INVALID_SERVICE_CONTRACT_ID" would be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_ID, P_INVALID_SERVICE_CONTRACT_ID

8a.3.2.5.3 Method deleteServiceContract()

Delete an existing service contract. All the Service Profiles associated with the service contract are also deleted. If there are any service instances running that are governed by this contract, or any of the profiles associated with it, then they will be terminated. Only the enterprise operator associated with the serviceContract is allowed to delete it, a "P_TASK_REFUSED" exception will be raised if a non‑associated enterprise operator invokes this method.

Parameters

serviceContractID : in TpServiceContractID

The "serviceContractID" parameter identifies the service contract that the enterprise operator wishes to delete. If the serviceContractID does not exist, a "P_INVALID_SERVICE_CONTRACT_ID" exception will be raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_CONTRACT_ID

8a.3.2.6 Interface Class IpServiceContractInfoQuery

Inherits from: IpInterface.

The enterprise operator uses this interface to query information about a given service contract.

<<Interface>>

IpServiceContractInfoQuery

describeServiceContract (serviceContractID : in TpServiceContractID) : TpServiceContractDescription

listServiceContracts () : TpServiceContractIDList

listServiceProfiles (serviceContractID : in TpServiceContractID) : TpServiceProfileIDList

8a.3.2.6.1 Method describeServiceContract()

Query information about the specified service contract. The enterprise operator invokes this operation to obtain information that is stored in the specified service contract. The enterprise operator can only obtain information about the service contracts that it has created.

Returns <serviceContractDescription>: The "serviceContract" parameter contains the description for the specified service contract.

Parameters

serviceContractID : in TpServiceContractID

The "serviceContractID" parameter identifies the service whose description is being requested.

Returns

TpServiceContractDescription

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_CONTRACT_ID

8a.3.2.6.2 Method listServiceContracts()

Returns a list of the IDs of service contracts created by the Enterprise Operator.

Returns <serviceContractIDs>: The "serviceContractIDs" parameter will contain a list of IDs for service contracts that the enterprise operator has created.

Parameters

No Parameters were identified for this method.

Returns

TpServiceContractIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.6.3 Method listServiceProfiles()

The enterprise operator invokes this operation to obtain a list of service profiles that are associated with a particular service contract.

Returns <serviceProfileIDs>: This contains the service profiles associated with a particular service contract.

Parameters

serviceContractID : in TpServiceContractID

The "serviceContractID" parameter identifies the service contract. If the serviceContractID is not recognised by the framework, an exception "P_INVALID_SERVICE_CONTRACT_ID" would be raised.

Returns

TpServiceProfileIDList

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_SERVICE_CONTRACT_ID

8a.3.2.7 Interface Class IpEntOpAccountManagement

Inherits from: IpInterface.

The enterprise operator, in the role of the service subscriber, uses this interface for the management of enterprise operator subscription accounts, such as modify and delete enterprise operator accounts. The EntOpID will be decided in an off‑line agreement between the FW operator and the EntOp, as the EntOp may require the ID to be something more meaningful than a random number. The EntOp account, consisting of the EntOpID, along with the list of valid properties and their modes and prescribed ranges, will be entered via a FW operator interface that is currently outside the scope of the API.

<<Interface>>

IpEntOpAccountManagement

modifyEntOpAccount (enterpriseOperatorProperties : in TpEntOpProperties) : void

deleteEntOpAccount () : void

8a.3.2.7.1 Method modifyEntOpAccount()

Modification of the enterprise operator information contained in the enterprise operator object.

Parameters

enterpriseOperatorProperties : in TpEntOpProperties

The "enterprise operator properties" parameter conveys the modified/populated information about the enterprise operator. The values of the "enterprise operator properties" can only be modified within the prescribed range, as negotiated earlier (an off‑line process) between the enterprise operator and the framework operator, otherwise a P_INVALID_PROPERTY exception is raised.

Raises

TpCommonExceptions, P_ACCESS_DENIED, P_INVALID_PROPERTY

8a.3.2.7.2 Method deleteEntOpAccount()

Deletes the specified enterprise operator object. Deletion of the enterprise operator object cannot be performed until the enterprise operator has deleted all the service contracts (and the Service Profiles) associated with it. An attempt to delete the enterprise operator account will result in a P_TASK_REFUSED exception if there are outstanding service contracts (and service profiles).

Parameters

No Parameters were identified for this method.

Raises

TpCommonExceptions, P_ACCESS_DENIED

8a.3.2.8 Interface Class IpEntOpAccountInfoQuery

Inherits from: IpInterface.

This interface is used by the enterprise operator to query information related to its own subscription account as held within the framework.

<<Interface>>

IpEntOpAccountInfoQuery

describeEntOpAccount () : TpEntOp

8a.3.2.8.1 Method describeEntOpAccount()

Query information about the enterprise operator. The enterprise operator invokes this operation to find out what information about itself is stored in the enterprise operator account object within the Framework.

Returns <enterpriseOperator>: The "enterpriseOperator" parameter conveys the information stored in the EntOp object about the enterprise operator. It contains the unique "enterprise operator ID" followed by a list of "enterprise operator properties". The enterprise operator properties is a list of name/value pairs which provide enterprise operator related information such as the name, organisation, address, phone, e‑mail, fax, payment method (credit card, bank account), etc. to the framework.

Parameters

No Parameters were identified for this method.

Returns

TpEntOp

Raises

TpCommonExceptions, P_ACCESS_DENIED