5.4 Exception Classes

29.198-023GPPOpen Service Access (OSA) Application Programming Interface (API)Part 2: Common data definitionsRelease 9TS

5.4.1 Underlying Technology Exceptions

All methods contain a signature showing, amongst other things, the explicit exceptions that they may throw. In addition to these exceptions, all methods can throw a number of implicit exceptions. These exceptions do not need to be included within the method signatures and are given below.

These exceptions would be thrown by the underlying technology (e.g. CORBA, Java™) as a result of problems encountered, for example, with the way the API method is invoked. They are a minimum set of exceptions that must be throwable by the underlying technology. Depending upon the underlying technology, additional method exceptions may also be thrown.

Description

Invalid Parameter: A method has been passed an invalid parameter argument

Invalid Parameter Value: A method parameter has been passed a value that is out of range

Parameter Missing: A method has not been passed a mandatory parameter argument

5.4.2 TpCommonExceptions

Defines the structure of the exception class which is applicable to all methods.

Structure Element Name

Structure Element Type

Structure Element Description

ExceptionType

TpInt32

Carries a constant from the list in the table below

ExtraInformation

TpString

Carries extra information to help identify the source of the exception, e.g. a parameter name

5.4.3 Constants associated with TpCommonExceptions

Name

Value

Description

P_RESOURCES_UNAVAILABLE

000Dh

The required resources in the network are not available

P_TASK_REFUSED

000Eh

The requested method has been refused

P_TASK_CANCELLED

000Fh

The requested method has been cancelled

P_NO_CALLBACK_ADDRESS_SET

0011h

The requested method is refused because no callback address has been set (this may be the result of a timing issue between setting the callback address and invoking the method)

P_POLICY_VIOLATION

0013h

A policy has been breached and therefore the request has been rejected. All the input to the method may be valid as meeting the required input for the operation, but using that input in the execution of the service resulted in conditions that require the service not to complete.

P_METHOD_NOT_SUPPORTED

0016h

The method is not allowed or supported within the context of the current service agreement.

P_INVALID_STATE

02E8h

Unexpected sequence of methods, i.e., the sequence does not match the specified state diagrams.

5.4.4 Exceptions available to all methods on all interfaces

The following are the list of exception classes which are available to all interfaces of the API.

Name

Description

P_APPLICATION_NOT_ACTIVATED

An application is unauthorised to access information and request services with regards to users that have deactivated that particular application.

In case the request was for information related to multiple user identities the reference to user identities that are causing this exception will be returned in the extra information of the exception.

P_INFORMATION_NOT_AVAILABLE

The requested information is not available. A reason might be that the information is unavailable in the core network or that the application is unauthorised to access the information. An application is unauthorised to access information and request services with regards to users that have set their privacy flag regarding that particular service. In case the request was for information related to multiple user identities, the reference to user identities that are causing this exception will be returned in the extra information of the exception.

P_INVALID_ADDRESS

Invalid address specified

P_INVALID_AMOUNT

Invalid amount specified.

P_INVALID_ASSIGNMENT_ID

The assignment ID is invalid

P_INVALID_CRITERIA

Invalid criteria specified

P_INVALID_CURRENCY

Invalid currency specified.

P_INVALID_EVENT_TYPE

Invalid event type

P_INVALID_INTERFACE_NAME

Invalid interface name

P_INVALID_INTERFACE_TYPE

The interface reference supplied by the client is the wrong type.

P_INVALID_NETWORK_STATE

Although the sequence of method calls is allowed by the gateway, the underlying protocol can not support it.

E.g., in some protocols some methods are only allowed by the protocol, when the call processing is suspended, e.g., after reporting an event that was monitored in interrupt mode.

P_INVALID_SESSION_ID

Invalid session ID.

P_INVALID_TIME_AND_DATE_FORMAT

Invalid date and time format provided

P_UNAUTHORISED_PARAMETER_VALUE

A method parameter value violates the Service Level Agreement

P_UNKNOWN_SUBSCRIBER

The subscriber is not known in the network or the application is An application is unauthorised to access information and request services with regards to users that are not subscribed to the application.

In case the request was for information related to multiple user identities, the reference to user identities that are causing this exception will be returned in the extra information of the exception.

P_UNSUPPORTED_ADDRESS_PLAN

An address contains an address plan which is not supported

P_INVALID_VERSION

An invalid version is specified.