8 Data Definitions

29.1983GPPOpen Service Architecture (OSA) Application Programming Interface (API) - Part 1Release 1999TS

8.1 Common Data definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa package.

8.1.1 Primitive Data Types

Type Name

Description

TpBoolean

Defines a Boolean data type.

TpInt32

Defines a signed 32 bit integer.

TpFloat

Defines a single precision float

TpString

Defines a string, comprising length and data.

8.1.2 Structured data types classification

Many different structured data types are used in OSA and a classification/clarification is required.

8.1.2.1 Structures made of data elements

This describes data types that can be considered as classes (in Java or C++) or structures (C++, IDL). The goal of these data types is to group pieces of information into a logical unit. Example: an TAddress data type may be defined in IDL as:

struct TpAddress {

TpAddressPlan Plan;

TpString AddrString;

TpString Name;

TpAddressPresentation Presentation;

TpAddressScreening Screening;

TpString SubAddressString;

};

8.1.2.2 Tagged choice of data elements (i.e.: Free unions)

This describes a data type, which actually evaluates to one of a choice of a number of data elements. This data element contains two parts: a tag data type (the tag part) which is used to identify the chosen data type, and the chosen data type itself (the union part). This form of data type is also referred to as a tagged union.

This data type can be implemented in IDL as a union with a switch statement for the tag part, and a set or case statements for the union part.

Example: The TCallError data type may be defined in IDL as:

union TpCallError switch (TCallErrorType) {

case CALL_ERROR_UNDEFINED:

TpCallErrorInfoDefault CallErrorUndefined;

case CALL_ERROR_ROUTING_ABORTED:

TpCallErrorInfoRoutingAborted CallErrorRoutingAborted;

case CALL_ERROR_CALL_ABANDONED:

TpCallErrorInfoCallAbandoned CallErrorCallAbandoned;

case CALL_ERROR_INVALID_ADDRESS:

TpCallErrorInfoInvalidAddress CallErrorInvalidAddress;

case CALL_ERROR_INVALID_STATE:

TpCallErrorInfoDefault CallErrorInvalidState;

case CALL_ERROR_INVALID_CRITERIA:

TpCallErrorInfoDefault CallErrorInvalidCriteria;

};

8.1.2.3 Collection of data elements

This describes a data type, which comprises an ordered or unordered collection of data elements of the same type. The number of data elements in the collection is always know and can be implicit (IDL) or may appear as an integer inside a structure depending on the language used. This data type can be implemented in IDL as a sequence.

Example:

typedef sequence<SessionID> SessionIDSet;

8.1.2.4 References

This describes a reference (or pointer) to a data type. This is primarily used to describe ‘out’ method parameters.

This data type may be implemented (for example, in C++) as a pointer. However, in some languages it may not be necessary for ‘out’ parameters to be implemented as pointers.

Example: The TAddressRef data type may be defined in C++ as:

typedef TAddress *TAddressRef;

8.1.3 Interface Definitions

8.1.3.1 IpOsa

Defines the address of an IpOsa Interface.

8.1.3.2 IpOsaRef

Defines a Reference to type IpOsa

8.1.3.3 IpOsaRefRef

Defines a Reference to type IpOsaRef

8.1.3.4 IpService

Defines the address of an IpService Interface.

8.1.3.5 IpServiceRef

Defines a Reference to type IpService

8.1.3.6 IpServiceRefRef

Defines a Reference to type IpServiceRef

8.1.4 Non primitive and structured type types definition

8.1.4.1 TpAssignmentID

This data type is identical to a TpInt32. It specifies a number which identifies an individual event notification enabled by the application or OSA service capability feature.

8.1.4.2 TpSessionID

Defines a network unique session ID. OSA uses this ID to identify sessions within an object implementing an interface capable of handling multiple sessions. For the different OSA service capability features, the sessionIDs are unique only in the context of a manager instantiation (e.g., within the context of one generic call control manager). As such if an application creates two instances of the same SCF manager it shall use different instantiations of the callback objects which implement the callback interfaces.

The session ID is identical to a TpInt32 type.

8.1.4.3 TpSessionIDSet

Defines a collection of data elements of TpSessionID.

8.1.4.4 TpDuration

This data type is a TpInt32 representing a time interval in milliseconds. A value of "-1" defines infinite duration and value of "-2" represents default duration.

8.1.4.5 TpResult

Defines the structure of data elements that specifies the result of a method call.

Structure Member Name

Structure Member Type

ResultType

TpResultType

ResultFacility

TpResultFacility

ResultInfo

TpResultInfo

8.1.4.6 TpResultType

Defines whether the method was successful or not.

Name

Value

Description

P_RESULT_FAILURE

0

Method failed

P_RESULT_SUCCESS

1

Method was successful

8.1.4.7 TpResultFacility

Defines the facility code of a result. In Release 99 of the OSA API, only P_RESULT_FACILITY_UNDEFINED must be used.

Name

Value

Description

P_RESULT_FACILITY_UNDEFINED

0

Undefined

8.1.4.8 TpResultInfo

Defines further information relating to the result of the method, such as error codes.

Name

Value

Description

P_RESULT_INFO_UNDEFINED

0000h

No further information present

P_INVALID_DOMAIN_ID

0001h

Invalid client ID

P_INVALID_AUTH_CAPABILITY

0002h

Invalid authentication capability

P_INVALID_AGREEMENT_TEXT

0003h

Invalid agreement text

P_INVALID_SIGNING_ALGORITHM

0004h

Invalid signing algorithm

P_INVALID_INTERFACE_NAME

0005h

Invalid interface name

P_INVALID_SERVICE_ID

0006h

Invalid service capability feature ID

P_INVALID_EVENT_TYPE

0007h

Invalid event type

P_SERVICE_NOT_ENABLED

0008h

The service capability feature ID does not correspond to a SCF that has been enabled

P_INVALID_ASSIGNMENT_ID

0009h

The assignment ID is invalid

P_INVALID_PARAMETER

000Ah

The method has been called with an invalid parameter

P_INVALID_PARAMETER_VALUE

000Bh

A method parameter has an invalid value

P_PARAMETER_MISSING

000Ch

A required parameter has not been specified in the method call

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_INVALID_DATE_TIME_FORMAT

0010h

Invalid date and time format provided

P_NO_CALLBACK_ADDRESS_SET

0011h

The requested method has been refused because no callback address is set

P_INVALID_SIGNATURE

0012h

Invalid digital signature

P_INVALID_SERVICE_TOKEN

0013h

The service capability feature token does not correspond to a token that had been issued, or the issued token has expired

P_ACCESS_DENIED

0014h

The client is not currently authenticated with the framework

P_INVALID_PROPERTY

0015h

The framework does not recognise the property supplied by the client

P_METHOD_NOT_SUPPORTED

0016h

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

P_NO_ACCEPTABLE_AUTH_CAPABILITY

0017h

An authentication mechanism, which is acceptable to the framework, is not supported by the client.

P_INVALID_INTERFACE_TYPE

0018h

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

P_INVALID_ACCESS_TYPE

0019h

The framework does not support the type of access interface requested by the client.

P_SERVICE_ACCESS_DENIED

001Ah

The client application is not allowed to access this service.

General security errors

P_USER_NOT_SUBSCRIBED

0030h

A service (or application) is unauthorised to access information and request SCFs with regards to users that are not subscribed to it.

P_APPLICATION_NOT_ACTIVATED

0031h

A service (or application) is unauthorised to access information and request SCFs with regards to its subscribed users that have deactivated that particular service (or application).

P_USER_PRIVACY

0032h

A service (or application) is unauthorised to access information and request an SCF with regards to its subscribed users that have set their privacy flag regarding that particular SCF.

P_GCCS_SERVICE_INFORMATION_MISSING

0100h

Information relating to the Call Control SCF could not be found

P_GCCS_SERVICE_FAULT_ENCOUNTERED

0101h

Fault detected in the Call Control SCF

P_GCCS_UNEXPECTED_SEQUENCE

0102h

Unexpected sequence of methods, i.e., the sequence does not match the specified state diagrams for the call or the call leg.

P_GCCS_INVALID_ADDDRESS

0103h

Invalid address specified

P_GCCS_INVALID_CRITERIA

0104h

Invalid criteria specified

P_GCCS_INVALID_NETWORK_STATE

0105h

Although the sequence of method calls is allowed by the OSA 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_GUIS_INVALID_CRITERIA

0300h

Invalid criteria specified

P_GUIS_ILLEGAL_ID

0301h

Information id specified is invalid

P_GUIS_ID_NOT_FOUND

0302h

A legal information id is not known to the User Interaction SCF

P_GUIS_ILLEGAL_RANGE

0303h

The values for minimum and maximum collection length are out of range.

P_GUIS_INVALID_COLLECTION_CRITERIA

0304h

Invalid collection criteria specified

P_GUIS_INVALID_NETWORK_STATE

0305h

Although the sequence of method calls is allowed by the OSA 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_GUIS_UNEXPECTED_SEQUENCE

0306h

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

P_DSCS_SERVICE_INFORMATION_MISSING

0400h

Information relating to the Data Session Control SCF could not be found

P_DSCS_SERVICE_FAULT_ENCOUNTERED

0401h

Fault detected in the Data Session Control SCF

P_DSCS_UNEXPECTED_SEQUENCE

0402h

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

P_DSCS_INVALID_ADDDRESS

0403h

Invalid address specified

P_DSCS_INVALID_STATE

0404h

Invalid state specified

P_DSCS_INVALID_CRITERIA

0405h

Invalid criteria specified

P_DSCS_INVALID_NETWORK_STATE

0406h

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

8.1.4.9 TpDate

This data type is identical to a TpString. It specifies the data in accordance with International Standard ISO 8601. This is defined as the string of characters in the following format:

YYYY-MM-DD

where the date is specified as:

YYYY four digits year

MM two digits month

DD two digits day

The date elements are separated by a hyphen character (-).

Example:

The 4 December 1998, is encoded as the string:

1998-12-04

8.1.4.10 TpTime

This data type is identical to a TpString. It specifies the time in accordance with International Standard ISO 8601. This is defined as the string of characters in the following format:

HH:MM:SS.mmm

or

HH:MM:SS.mmmZ

where the time is specified as:

HH two digits hours (24h notation)

MM two digits minutes

SS two digits seconds

mmm three digits fractions of a second (i.e. milliseconds)

The time elements are separated by a colon character (:).The date and time are separated by a space. Optionally, a capital letter Z may be appended to the time field to indicate Universal Time (UTC). Otherwise, local time is assumed.

Example

For local time, 10:30 and 15 seconds is encoded as the string:

10:30:15.000

or in UTC it would be:

10:30:15.000Z

8.1.4.11 TpDateAndTime

This data type is identical to a TpString. It specifies the data and time in accordance with International Standard ISO 8601. This is defined as the string of characters in the following format:

HH:MM:SS.mmm

or

YYYY-MM-DD HH:MM:SS.mmmZ

where the date is specified as:

YYYY four digits year

MM two digits month

DD two digits day

The date elements are separated by a hyphen character (-).

The time is specified as:

HH two digits hours (24h notation)

MM two digits minutes

SS two digits seconds

mmm three digits fractions of a second (i.e. milliseconds)

A colon character separates the time elements (:). The date and time are separated by a space. Optionally, a capital letter Z may be appended to the time field to indicate Universal Time (UTC). Otherwise, local time is assumed.

Example

The 4 December 1998, at 10:30 and 15 seconds is encoded as the string:

1998-12-04 10:30:15.000

for local time, or in UTC it would be:

1998-12-04 10:30:15.000Z

8.1.4.12 TpAddress

Defines the structure of data elements that specifies an address.

Structure Member Name

Structure Member Type

Plan

TpAddressPlan

AddrString

TpString

Name

TpString

Presentation

TpAddressPresentation

Screening

TpAddressScreening

SubAddressString

TpString

The AddrString defines the actual address information and the structure of the string depends on the Plan. The following table gives an overview of the format of the AddrString for the different address plans.

Address Plan

AddrString Format Description

Example

P_ADDRESS_PLAN_NOT_PRESENT

Not applicable

P_ADDRESS_PLAN_UNDEFINED

Not applicable

P_ADDRESS_PLAN_IP

For Ipv4 the dotted quad notation is used. Also for IPv6 the dotted notation is used. The address can optionally be followed by a port number separated by a colon.

“127.0.0.1:42”

P_ADDRESS_PLAN_MULTICAST

An Ipv4 class D address or Ipv6 equivalent in dotted notation.

“224.0.0.0”

P_ADDRESS_PLAN_UNICAST

A non multicast or broadcast IP address in dotted notation.

“127.0.0.1”

P_ADDRESS_PLAN_E164

An international number without the international access code, including the country code and excluding the leading zero of the area code.

“31161249111”

P_ADDRESS_PLAN_AESA

The ATM End System Address in binary format (40 bytes)

01234567890ABCDEF01234567890ABCDEF01234567

P_ADDRESS_PLAN_URL

A uniform resource locator as defined in IETF RFC 1738

“http://www.parlay.org”

P_ADDRESS_PLAN_NSAP

The binary representation of the Network Service Access Point

490001AA000400010420

P_ADDRESS_PLAN_SMTP

An e-mail address as specified in IETF RFC822

“webmaster@parlay.org”

P_ADDRESS_PLAN_X400

The X400 address structured as a set of attibute value pairs separated by semicolons.

“C=nl;ADMD= ;PRMD=uninet;O=parlay;S=Doe;I=S;G=John’

8.1.4.13 TpAddressSet

Defines a collection of TpAddress elements.

8.1.4.14 TpAddressPlan

Defines the address plan (or numbering plan) used. It is also used to indicate whether an address is actually defined in a Address data element.

Name

Value

Description

P_ADDRESS_PLAN_NOT_PRESENT

-1

No Address Present

P_ADDRESS_PLAN_UNDEFINED

0

Undefined

P_ADDRESS_PLAN_IP

1

IP

P_ADDRESS_PLAN_MULTICAST

2

Multicast

P_ADDRESS_PLAN_UNICAST

3

Unicast

P_ADDRESS_PLAN_E164

4

E.164

P_ADDRESS_PLAN_AESA

5

AESA

P_ADDRESS_PLAN_URL

6

URL

P_ADDRESS_PLAN_NSAP

7

NSAP

P_ADDRESS_PLAN_SMTP

8

SMTP

P_ADDRESS_PLAN_X400

10

X.400

8.1.4.15 TpAddressPresentation

Defines whether an address can be presented to an end user.

Name

Value

Description

P_ADDRESS_PRESENTATION_UNDEFINED

0

Undefined

P_ADDRESS_PRESENTATION_ALLOWED

1

Presentation Allowed

P_ADDRESS_PRESENTATION_RESTRICTED

2

Presentation Restricted

P_ADDRESS_PRESENTATION_ADDRESS_NOT_AVAILABLE

3

Address not available for presentation

8.1.4.16 TpAddressRange

This type is identical to TpAddress with the difference that the AddrString can contain wildcarts.

Two wildcards are allowed: * which matches zero or more characters and ? which matches exactly one character. The wildcards are only allowed at the end or at the beginning of the addrString.

Some examples for E164 addresses:

“123” matches specified number.

“123*” matches all numbers starting with 123 (including 123 itself).

“123??*” matches all numbers starting with 123 and at least 5 digits long.

“123???” matches all numbers starting with 123 and exactly 6 digits long

For e-mail style addresses, the wildcards can be used at the beginning of the addrString:

 *@3gpp.org matches all email addresses in the 3gpp.org domain.

The following address ranges are illegal:

– 1?3

– 1*3

– ?123*

8.1.4.17 TpAddressScreening

Defines whether an address has been screened by the application.

Name

Value

Description

P_ADDRESS_SCREENING_UNDEFINED

0

Undefined

P_ADDRESS_SCREENING_USER_VERIFIED_PASSED

1

user provided address
verified and passed

P_ADDRESS_SCREENING_USER_NOT_VERIFIED

2

user provided address
not verified

P_ADDRESS_SCREENING_USER_VERIFIED_FAILED

3

user provided address
verified and failed

P_ADDRESS_SCREENING_NETWORK

4

Network provided address (Note that even though the application may provide the address to the gateway, from the end-user point of view it is still regarded as a network provided address)

8.1.4.18 TpAddressError

Defines the reasons why an address is invalid.

Name

Value

Description

P_ADDRESS_INVALID_UNDEFINED

0

Undefined error

P_ADDRESS_INVALID_MISSING

1

Mandatory address not present

P_ADDRESS_INVALID_MISSING_ELEMENT

2

Mandatory address element not present

P_ADDRESS_INVALID_OUT_OF_RANGE

3

Address is outside of the valid range

P_ADDRESS_INVALID_INCOMPLETE

4

Address is incomplete

P_ADDRESS_INVALID_CANNOT_DECODE

5

Address cannot be decoded

8.1.4.19 TpURL

This data type is identical to a TpString and contains a URL address. The usage of this type is distinct of TpAddress, which can also hold an URL. The latter contains a user address which can be specified in many ways: IP, mail, URL, X.300, E164. On the other hand, the TpURL type does not hold the address of a user and always represents a URL. This type is used in user interaction and defines the URL of the text or stream to be sent to an end-user. It is therefore inappropriate to use a general address here.

8.1.4.20 TpPrice

This data type is identical to a TpString. It specifies price information, which is used in user interaction when an announcement is being played and additional information is given to the user. This is defined as the string of characters (digits) in the following format:

DDDDDD.DD

8.1.4.21 TpAoCInfo

Defines the Sequence of Data Elements that specify the Advice Of Charge information to be sent to the terminal.

Sequence Element Name

Sequence Element Type

Description

ChargeOrder

TpAoCOrder

Charge order

Currency

TpString

Currency unit according to ISO-4217:1995

8.1.4.22 TpAoCOrder

Defines the Tagged Choice of Data Elements that specify the charge plan for the call.

Tag Element Type

TpAoCOrderCategory

Tag Element Value

Choice Element Type

Choice Element Name

P_CHARGE_ADVICE_INFO

TpChargeAdviceInfo

ChargeAdviceInfo

P_CHARGE_PER_TIME

TpChargePerTime

ChargePerTime

P_CHARGE_NETWORK

TpString

NetworkCharge

8.1.4.23 TpCallAoCOrderCategory

Name

Value

Description

P_CHARGE_ADVICE_INFO

0

Set of GSM Charge Advice Information elements according to 3GPP TS 22.024

P_CHARGE_PER_TIME

1

Charge per time

P_CHARGE_NETWORK

2

Operator specific charge plan specification, e.g. charging table name / charging table entry

8.1.4.24 TpChargeAdviceInfo

Defines the Sequence of Data Elements that specify the two sets of Advice of Charge parameters. The first set defines the current tariff. The second set may be used in case of a tariff switch in the network.

Sequence Element Name

Sequence Element Type

Description

CurrentCAI

TpCAIElements

Current tariff

NextCAI

TpCAIElements

Next tariff after tariff switch

8.1.4.25 TpCAIElements

Defines the Sequence of Data Elements that specify theCharging Advice Information elements according to 3GPP TS 22.024.

Sequence Element Name

Sequence Element Type

Description

UnitsPerInterval

TpInt32

Units per interval

SecondsPerTimeInterval

TpInt32

Seconds per time interval

ScalingFactor

TpInt32

Scaling factor

UnitIncrement

TpInt32

Unit increment

UnitsPerDataInterval

TpInt32

Units per data interval

SegmentsPerDataInteral

TpInt32

Segments per data interal

InitialSecsPerTimeInterval

TpInt32

Initial secs per time interval

8.1.4.26 TpChargePerTime

Defines the Sequence of Data Elements that specify the time based charging information.

Sequence Element Name

Sequence Element Type

Description

InitialCharge

TpInt32

Initial charge amount (in currency units * 0.0001)

CurrentChargePerMinute

TpInt32

Current tariff (in currency units * 0.0001)

NextChargePerMinute

TpInt32

Next tariff (in currency units * 0.0001) after tariff switch

Only used in setAdviceOfCharge()

8.2 Framework Data Definitions

This section provides the framework specific data definitions necessary to support the OSA interface specification.

This document is written using Hypertext link, to aid navigation through the data structures. Underlined text represents Hypertext links.

The general format of a data definition specification is the following:

 Data type, that shows the name of the data type.

 Description, that describes the data type.

 Tabular specification, that specifies the data types and values of the data type.

 Example, if relevant, shown to illustrate the data type.

8.2.1 Common Framework Data Definitions

8.2.1.1 TpClientAppID

This is an identifier for the client application. It is used to identify the client to the framework. This data type is identical to TpString and is defined as a string of characters that uniquely identifies the application. The content of this string shall be unique for each OSA API implementation (or unique for a network operator’s domain). This unique identifier shall be negotiated with the OSA operator and the application shall use it to identify itself.

8.2.1.2 TpClientAppIDList

This data type defines a Numbered Set of Data Elements of type TpClientAppID.

8.2.1.3 TpDomainID

Defines the Tagged Choice of Data Elements that specify either the framework or the type of entity attempting to access the framework.

Tag Element Type

TpDomainIDType

Tag Element Value

Choice Element Type

Choice Element Name

P_FW

TpFwID

FwID

P_CLIENT_APPLICATION

TpClientAppID

ClientAppID

P_ENT_OP

TpEntOpID

EntOpID

P_REGISTERED_SERVICE

TpServiceID

ServiceID

P_SERVICE_SUPPLIER

TpServiceSupplierID

ServiceSupplierID

8.2.1.4 TpDomainIDType

Defines either the framework or the type of entity attempting to access the framework

Name

Value

Description

P_FW

0

The framework

P_CLIENT_APPLICATION

1

A client application

P_ENT_OP

2

An enterprise operator

P_REGISTERED_SERVICE

3

A registered service

P_SERVICE_SUPPLIER

4

A service supplier

8.2.1.5 TpEntOpID

This data type is identical to TpString and is defined as a string of characters that identifies an enterprise operator. In conjunction with the application it uniquely identifies the enterprise operator which uses a particular OSA Service Capability Feature.

8.2.1.6 TpPropertyName

This data type is identical to TpString. It is the name of a generic “property”.

8.2.1.7 TpPropertyValue

This data type is identical to TpString. It is the value (or the list of values) associated with a generic “property”.

8.2.1.8 TpProperty

This data type is a Sequence of Data Elements which describes a generic “property”. It is a structured data type consisting of the following {name,value} pair:

Sequence Element

Name

Sequence Element

Type

PropertyName

TpPropertyName

PropertyValue

TpPropertyValue

8.2.1.9 TpPropertyList

This data type defines a Numbered List of Data Elements of type TpProperty.

8.2.1.10 TpEntOpIDList

This data type defines a Numbered Set of Data Elements of type TpEntOpID.

8.2.1.11 TpFwID

This data type is identical to TpString and identifies the Framework to a client application (or Service Capability Feature)

8.2.1.12 TpService

This data type is a Sequence of Data Elements which describes a registered SCFs. It is a structured type which consists of:

Sequence Element

Name

Sequence Element

Type

Documentation

ServiceID

TpServiceID

ServicePropertyList

TpServicePropertyList

8.2.1.13 TpServiceList

This data type defines a Numbered Set of Data Elements of type TpService.

8.2.1.14 TpServiceDescription

This data type is a Sequence of Data Elements which describes a registered SCF. It is a structured data type which consists of:

Sequence Element

Name

Sequence Element

Type

Documentation

ServiceTypeName

TpServiceTypeName

ServicePropertyList

TpServicePropertyList

8.2.1.15 TpServiceID

This data type is identical to a TpString, and is defined as a string of characters that uniquely identifies an instance of a SCF interface. The string is automatically generated by the Framework, and comprises a TpUniqueServiceNumber, TpServiceNameString, and a number of relevant TpServiceSpecString, which are concatenated using a forward separator (/) as the separation character.

8.2.1.16 TpServiceIDList

This data type defines a Numbered Set of Data Elements of type TpServiceID.

8.2.1.17 TpServiceIDRef

Defines a Reference to type TpServiceId.

8.2.1.18 TpServiceNameString

This data type is identical to a TpString, and is defined as a string of characters that uniquely identifies the name of an SCF interface. Other Network operator specific capabilities may also be used, but should be preceded by the string "SP_".The following values are defined for OSA release 99.

Character String Value

Description

NULL

An empty (NULL) string indicates no SCF name

P_CALL_CONTROL

The name of the Call Control SCF

P_USER_INTERACTION

The name of the User Interaction SCFs

P_TERMINAL_CAPABILITIES

The name of the Terminal Capabilities SCF

P_USER_LOCATION_CAMEL

The name of the Network User Location SCF

P_USER_STATUS

The name of the User Status SCF

P_DATA_SESSION_CONTROL

The name of the Data Session Control SCF

8.2.1.19 TpServiceSpecString

This data type is identical to a TpString, and is defined as a string of characters that uniquely identifies the name of an SCF specialization interface. Other network operator specific capabilities may also be used, but should be preceded by the string "SP_".The following values are defined for OSA release 99.

Character String Value

Description

NULL

An empty (NULL) string indicates no SCF specialization

P_CALL

The Call specialization of the of the User Interaction SCF

8.2.1.20 TpUniqueServiceNumber

This data type is identical to a TpString, and is defined as a string of characters that represents a unique number that is used to build the service ID (refer to TpServiceID).

8.2.1.21 TpServiceTypeProperty

This data type is a Sequence of Data Elements which describes a service property associated with a service type. It defines the name and mode of the service property, and also the service property type: e.g. boolean, integer. It is similar to, but distinct from, TpServiceProperty. The latter is associated with an actual service: it defines the service property’s name and mode, but also defines the list of values assigned to it.

Sequence Element

Name

Sequence Element

Type

Documentation

ServicePropertyName

TpServicePropertyName

ServicePropertyMode

TpServicePropertyMode

ServicePropertyTypeName

TpServicePropertyTypeName

8.2.1.22 TpServiceTypePropertyList

This data type defines a Numbered Set of Data Elements of type TpServiceTypeProperty.

8.2.1.23 TpServicePropertyMode

This type is left as a placeholder but is not used in release 99.This defines SCF property modes.

Name

Value

Documentation

NORMAL

0

The value of the corresponding SCF property type may optionally be provided

MANDATORY

1

The value of the corresponding SCF property type must be provided at service registration time

READONLY

2

The value of the corresponding SCF property type is optional, but once given a value it may not be modified

MANDATORY_READONLY

3

The value of the corresponding SCF property type must be provided and subsequently it may not be modified.

8.2.1.24 TpServicePropertyTypeName

This data type is identical to TpString and describes a valid SCF property name. The valid SCF property names are listed in the SCF data definition.

8.2.1.25 TpServicePropertyName

This data type is identical to TpString. It defines a valid SFC property name. Valid SCF property names are listed in the SCF data definition.

8.2.1.26 TpServicePropertyNameList

This data type defines a Numbered Set of Data Elements of type TpServicePropertyName.

8.2.1.27 TpServicePropertyValue

This data type is identical to TpString and describes a valid value of a SCF property. The valid SCF property values are given in the SCF data definition.

8.2.1.28 TpServicePropertyValueList

This data type defines a Numbered Set of Data Elements of type TpServicePropertyValue

8.2.1.29 TpServiceProperty

This data type is a Sequence of Data Elements which describes an “SCF property”. It is a structured data type which consists of:

Sequence Element

Name

Sequence Element

Type

Documentation

ServicePropertyName

TpServicePropertyName

ServicePropertyValueList

TpServicePropertyValueList

ServicePropertyMode

TpServicePropertyMode

8.2.1.30 TpServicePropertyList

This data type defines a Numbered Set of Data Elements of type TpServiceProperty.

8.2.1.31 TpServiceSupplierID

This is an identifier for a service supplier. It is used to identify the supplier to the framework. This data type is identical to TpString.

8.2.1.32 TpServiceTypeDescription

This type is left as a placeholder but is not used in release 99.

This data type is a Sequence_of_Data_Elements which describes an SCF type. It is a structured data type. It consists of:

Sequence Element

Name

Sequence Element

Type

Documentation

ServiceTypePropertyList

TpServiceTypePropertyList

a sequence of property name and property mode tuples associated with the SCF type

ServiceTypeNameList

TpServiceTypeNameList

the names of the super types of the associated SCF type

EnabledOrDisabled

TpBoolean

an indication whether the SCF type is enabled (true) or disabled (false)

8.2.1.33 TpServiceTypeName

This data type is identical to TpString and describes a valid SCF type name.

8.2.1.34 TpServiceTypeNameList

This data type defines a Numbered Set of Data Elements of type TpServiceTypeName.

8.2.2 Trust and Security Management Data Definitions

8.2.2.1 TpAccessType

This data type is identical to a TpString. This identifies the type of access interface requested by the client application. If they request P_ACCESS, then a reference to the IpAccess interface is returned. (Network operators can define their own access interfaces to satisfy client requirements for different types of access. These can be selected using the TpAccessType, but should be preceded by the string "SP_". The following value is defined for OSA release 99:

String Value

Description

P_ACCESS

Access using the OSA Access Interfaces: IpAccess and IpAppAccess

8.2.2.2 TpAuthType

This data type is identical to a TpString. It identifies the type of authentication mechanism requested by the client. It provides Network operators and client’s with the opportunity to use an alternative to the OSA Authentication interface, e.g. CORBA Security. OSA Authentication is the default authentication method. Other Network operator specific capabilities may also be used, but should be preceded by the string “SP_”. The following value is defined for OSA release 99:

String Value

Description

P_AUTHENTICATION

Indicates the default authentication method, i.e. the IpAuthentication and IpAppAuthentication interfaces.

8.2.2.3 TpAuthCapability

This data type is identical to a TpString, and is defined as a string of characters that identify the authentication capabilities that could be supported by the OSA. Other Network operator specific capabilities may also be used, but should be preceded by the string "SP_". Capabilities may be concatenated, using commas (,) as the separation character. The following values are defined for OSA release 99.

String Value

Description

NULL

An empty (NULL) string indicates no client capabilities.

P_DES_56

A simple transfer of secret information that is shared between the client application and the framework with protection against interception on the link provided by the DES algorithm with a 56bit shared secret key

P_DES_128P_DES_1P_DES_128

A simple transfer of secret information that is shared between the client entity and the framework with protection against interception on the link provided by the DES algorithm with a 128bit shared secret key

P_RSA_512

A public-key cryptography system providing authentication without prior exchange of secrets using 512 bit keys

P_RSA_1024

A public-key cryptography system providing authentication without prior exchange of secrets using 1024bit keys

8.2.2.4 TpAuthCapabilityList

This data type is identical to a TpString. It is a string of multiple TpAuthCapability concatenated using a comma (,)as the separation character.

8.2.2.5 TpEndAccessProperties

This data type is of type TpPropertyList. It identifies the actions that the framework should perform when an application or service capability feature entity ends its access session (e.g. existing service capability or application sessions may be stopped, or left running).

8.2.2.6 TpAuthDomain

This is Sequence of Data Elements containing all the data necessary to identify a domain: the domain identifier, and a reference to the authentication interface of the domain

Sequence Element Name

Sequence Element Type

Description

DomainID

TpDomainID

Identifies the domain for authentication. This identifier is assigned to the domain during the initial contractual agreements, and is valid during the lifetime of the contract.

AuthInterface

IpOSARef

Identifies the authentication interface of the specific entity. This data element has the same lifetime as the domain authentication process, i.e. in principle a new interface reference can be provided each time a domain intents to access another.

8.2.2.7 TpInterfaceName

This data type is identical to a TpString, and is defined as a string of characters that identify the names of the framework SCFs that are to be supported by the OSA API. Other Network operator specific SCFs may also be used, but should be preceded by the string "SP_".The following values are defined for OSA release 99.

Character String Value

Description

P_DISCOVERY

The name for the Discovery interface.

P_OAM

The name for the OA&M interface.

P_LOAD_MANAGER

The name for the Load Manager interface.

P_FAULT_MANAGER

The name for the Fault Manager interface.

P_HEARTBEAT_MANAGEMENT

The name for the Heartbeat Management interface.

P_REGISTRATION

The name for the Service Registration interface.

8.2.2.8 TpServiceAccessControl

This is Sequence of Data Elements containing the access control policy information controlling access to the service capability feature, and the trustLevel that the Network operator has assigned to the client application.

Sequence Element Name

Sequence Element Type

Policy

TpString

TrustLevel

TpString

The policy parameter indicates whether access has been granted or denied. If granted then the parameter trustLevel must also have a value.

The trustLevel parameter indicates the trust level that the Network operator has assigned to the client application.

8.2.2.9 TpServiceToken

This data type is identical to a TpString, and identifies a selected SCF. This is a free format text token returned by the framework, which can be signed as part of a service agreement. This will contain Network operator specific information relating to the service level agreement. The serviceToken has a limited lifetime, which is the same as the lifetime of the service agreement in normal conditions. If something goes wrong the serviceToken expires, and any method accepting the serviceToken will return an error code (P_INVALID_SERVICE_TOKEN). Service Tokens will automatically expire if the client or framework invokes the endAccess method on the other’s corresponding access interface.

8.2.2.10 TpSignatureAndServiceMgr

This is a Sequence of Data Elements containing the digital signature of the framework for the service agreement, and a reference to the SCF manager interface of the SCF.

Sequence Element Name

Sequence Element Type

DigitalSignature

TpString

ServiceMgrInterface

IpServiceRef

The digitalSignature is the signed version of a hash of the service token and agreement text given by the client application.

The ServiceMgrInterface is a reference to the SCF manager interface for the selected SCF.

8.2.2.11 TpSigningAlgorithm

This data type is identical to a TpString, and is defined as a string of characters that identify the signing algorithm that must be used. Other Network operator specific capabilities may also be used, but should be preceded by the string "SP_". The following values are defined for OSA release 99.

String Value

Description

NULL

An empty (NULL) string indicates no signing algorithm is required

P_MD5_RSA_512

MD5 takes an input message of arbitrary length and produces as output a 128-bit message digest of the input. This is then encrypted with the private key under the RSA public-key cryptography system using a 512 bit key.

P_MD5_RSA_1024

MD5 takes an input message of arbitrary length and produces as output a 128-bit message digest of the input. This is then encrypted with the private key under the RSA public- key cryptography system using a 1024 bit key

8.2.3 Integrity Management Data Definitions

8.2.3.1 TpActivityTestRes

This type is identical to TpString and is an implementation specific result. The values in this data type are “Available” or “Unavailable”.

8.2.3.2 TpFaultStatsRecord

This defines the set of records to be returned giving fault information for the requested time period.

Sequence Element Name

Sequence Element Type

Period

TpTimeInterval

FaultRecords

TpFaultStatsSet

8.2.3.3 TpFaultStats

This defines the sequence of data elements which provide the statistics on a per fault type basis.

Sequence Element Name

Sequence Element Type

Description

Fault

TpInterfaceFault

Occurrences

TpInt32

The number of separate instances of this fault

MaxDuration

TpInt32

The number of seconds duration of the longest fault

TotalDuration

TpInt32

The cumulative duration (all occurrences)

NumberOfClientsAffected

TpInt32

The number of clients informed of the fault by the Fw

Occurrences is the number of separate instances of this fault during the period. MaxDuration and TotalDuration are the number of seconds duration of the longest fault and the cumulative total during the period. NumberOfClientsAffected is the number of clients informed of the fault by the framework.

8.2.3.4 TpFaultStatsSet

This data type defines a Numbered Set of Data Elements of type TpFaultStats

8.2.3.5 TpActivityTestID

This data type is identical to a TpInt32, and is used as a token to match activity test requests with their results..

8.2.3.6 TpInterfaceFault

Defines the cause of the interface fault detected.

Name

Value

Description

INTERFACE_FAULT_UNDEFINED

0

Undefined

INTERFACE_FAULT_LOCAL_FAILURE

1

A fault in the local API software or hardware has been detected

INTERFACE_FAULT_GATEWAY_FAILURE

2

A fault in the gateway API software or hardware has been detected

INTERFACE_FAULT_PROTOCOL_ERROR

3

An error in the protocol used on the client-gateway link has been detected

8.2.3.7 TpSvcUnavailReason

Defines the reason why a SCF is unavailable.

Name

Value

Description

SERVICE_UNAVAILABLE_UNDEFINED

0

Undefined

SERVICE_UNAVAILABLE_LOCAL_FAILURE

1

The Local API software or hardware has failed

SERVICE_UNAVAILABLE_GATEWAY_FAILURE

2

The gateway API software or hardware has failed

SERVICE_UNAVAILABLE_OVERLOADED

3

The SCF is fully overloaded

SERVICE_UNAVAILABLE_CLOSED

4

The SCF has closed itself (e.g. to protect from fraud or malicious attack)

8.2.3.8 TpFWUnavailReason

Defines the reason why the Framework is unavailable.

Name

Value

Description

FW_UNAVAILABLE_UNDEFINED

0

Undefined

FW_UNAVAILABLE_LOCAL_FAILURE

1

The Local API software or hardware has failed

FW_UNAVAILABLE_GATEWAY_FAILURE

2

The gateway API software or hardware has failed

FW_UNAVAILABLE_OVERLOADED

3

The framework is fully overloaded

FW_UNAVAILABLE_CLOSED

4

The framework has closed itself (e.g. to protect from fraud or malicious attack)

FW_UNAVAILABLE_PROTOCOL_FAILURE

5

The protocol used on the client-gateway link has failed

8.2.3.9 TpLoadLevel

Defines the Sequence of Data Elements that specify load level values.

Name

Value

Description

LOAD_LEVEL_NORMAL

0

Normal load

LOAD_LEVEL_OVERLOAD

1

Overload

LOAD_LEVEL_SEVERE_OVERLOAD

2

Severe Overload

8.2.3.10 TpLoadThreshold

Defines the Sequence of Data Elements that specify the load threshold value. The actual load threshold value is application and SCF dependent, so is their relationship with load level.

Sequence Element Name

Sequence Element Type

LoadThreshold

TpFloat

8.2.3.11 TpLoadInitVal

Defines the Sequence of Data Elements that specify the pair of load level and associated load threshold value.

Sequence Element Name

Sequence Element Type

LoadLevel

TpLoadLevel

LoadThreshold

TpLoadThreshold

8.2.3.12 TpTimeInterval

Defines the Sequence of Data Elements that specify a time interval.

Sequence Element Name

Sequence Element Type

StartTime

TpDateAndTime

StopTime

TpDateAndTime

8.2.3.13 TpLoadPolicy

Defines the load balancing policy.

Sequence Element Name

Sequence Element Type

LoadPolicy

TpString

8.2.3.14 TpLoadStatistic

Defines the Sequence of Data Elements that represents a load statistic record for a specific entity (i.e. framework, service or application) at a specific date and time.

Sequence Element Name

Sequence Element Type

LoadStatisticEntityID

TpLoadStatisticEntityID

TimeStamp

TpDateAndTime

LoadStatisticInfo

TpLoadStatisticInfo

8.2.3.15 TpLoadStatisticList

Defines a Numbered List of Data Elements of type TpLoadStatistic.

8.2.3.16 TpLoadStatisticData

Defines the Sequence of Data Elements that represents load statistic information

Sequence Element Name

Sequence Element Type

LoadValue

TpFloat

LoadLevel

TpLoadLevel

Note: LoadValue is expressed as a percentage.

8.2.3.17 TpLoadStatisticEntityID

Defines the Tagged Choice of Data Elements that specify the type of entity (i.e. service, application or framework) providing load statistics.

Tag Element Type

TpLoadStatisticEntityType

Tag Element Value

Choice Element Type

Choice Element Name

P_LOAD_STATISTICS_FW_TYPE

TpFwID

FrameworkID

P_LOAD_STATISTICS_SVC_TYPE

TpServiceID

ServiceID

P_LOAD_STATISTICS_APP_TYPE

TpClientAppID

ClientAppID

8.2.3.18 TpLoadStatisticEntityType

Defines the type of entity (i.e. service, application or framework) supplying load statistics.

Name

Value

Description

P_LOAD_STATISTICS_FW_TYPE

0

Framework-type load statistics

P_LOAD_STATISTICS_SVC_TYPE

1

Service-type load statistics

P_LOAD_STATISTICS_APP_TYPE

2

Application-type load statistics

8.2.3.19 TpLoadStatisticInfo

Defines the Tagged Choice of Data Elements that specify the type of load statistic information (i.e. valid or invalid).

Tag Element Type

TpLoadStatisticInfoType

Tag Element Value

Choice Element Type

Choice Element Name

P_LOAD_STATISTICS_VALID

TpLoadStatisticData

LoadStatisticData

P_LOAD_STATISTICS_INVALID

TpLoadStatisticError

LoadStatisticError

8.2.3.20 TpLoadStatisticInfoType

Defines the type of load statistic information (i.e. valid or invalid).

Name

Value

Description

P_LOAD_STATISTICS_VALID

0

Valid load statistics

P_LOAD_STATISTICS_INVALID

1

Invalid load statistics

8.2.3.21 TpLoadStatisticError

Defines the error code associated with a failed attempt to retrieve any load statistics information.

Name

Value

Description

P_LOAD_INFO_ERROR_UNDEFINED

0

Undefined error

P_LOAD_INFO_UNAVAILABLE

1

Load statistics unavailable

8.3 Generic Call Control Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.gccs package.

8.3.1 Interface definitions

8.3.1.1 IpAppCall

Defines the address of an IAppCall Interface.

8.3.1.2 IpAppCallRef

Defines a Reference to type IAppCall

8.3.1.3 IpAppCallRefRef

Defines a Reference to type IAppCallRef.

8.3.1.4 IpAppCallControlManager

Defines the address of an IAppCallControlManager Interface.

8.3.1.5 IpAppCallControlManagerRef

Defines a Reference to type IAppCallControlManager.

8.3.1.6 IpCall

Defines the address of an ICall Interface.

8.3.1.7 IpCallRef

Defines a Reference to type ICall.

8.3.1.8 IpCallRefRef

Defines a Reference to type ICallRef.

8.3.1.9 IpCallControlManager

Defines the address of an ICallControlManager Interface.’

8.3.1.10 IpCallControlManagerRef

Defines a Reference to type ICallControlManager.

8.3.2 Event Notification data definitions

8.3.2.1 TpCallEventName

Defines the names of events being notified with a new call request. The following events are supported. The values may be combined by a logical ‘OR’ function when requesting the notifications. Additional events that can be requested / received during the call process are found in the TpCallReportType data-type.

Name

Value

Description

P_EVENT_NAME_UNDEFINED

0

Undefined

P_EVENT_GCCS_OFFHOOK_EVENT

1

GCCS – Offhook event.

This can be used for hot-line features. In case this event is set in the TpCallEventCriteria, only the originating address(es) may be specified in the criteria.

P_EVENT_GCCS_ADDRESS_COLLECTED_EVENT

2

GCCS – Address information collected

The network has collected the information from the calling party, but not yet analysed the information. The number can still be incomplete. Applications might set notification for this event when part of the number analysis needs to be done in the application.

P_EVENT_GCCS_ADDRESS_ANALYSED_EVENT

4

GCCS – Address information is analysed.

The dialled number is a valid and complete number in the network.

P_EVENT_GCCS_CALLED_PARTY_BUSY

8

GCCS – Called party is busy

P_EVENT_GCCS_CALLED_PARTY_UNREACHABLE

16

GCCS – Called party is unreachable

This can happen when the called party has a mobile phone that is switched off.

P_EVENT_GCCS_NO_ANSWER_FROM_CALLED_PARTY

32

GCCS – No answer from called party

P_EVENT_GCCS_ROUTE_SELECT_FAILURE

64

GCCS – Failure in routing the call

P_EVENT_GCCS_ANSWER_FROM_CALL_PARTY

128

GCCS – Party answered call.

8.3.2.2 TpCallEventCriteria

Defines the Sequence of Data Elements that specify the criteria for an event notification.

Sequence Element Name

Sequence Element Type

Description

DestinationAddress

TpAddressRange

Defines the destination address or address range for which the notification is requested

OriginationAddress

TpAddressRange

Defines the origination address or address range for which the notification is requested

CallEventName

TpCallEventName

Name of the event(s)

CallNotificationType

TpCallNotificationType

Indicates whether it is related to the originating or the terminating user in the call.

MonitorMode

TpCallMonitorMode

Defines the mode that the call is in following the notification.
Monitor mode P_CALL_MONITOR_MODE_DO_NOT_MONITOR is not a legal value here.

8.3.2.3 TpCallEventCriteriaResult

Defines a sequence of data elements that specify a requested call event notification criteria with the associated assignmentID.

Sequence Element Name

Sequence Element Type

Sequence Element Description

EventCriteria

TpCallEventCriteria

The event criteria that were specified by the application.

AssignmentID

TpInt32

The associated assignementID. This can be used to disable the notification.

8.3.2.4 TpCallEventCriteriaResultSet

Defines a set of TpCallEventCriteriaResult.

8.3.2.5 TpCallNotificationType

Defines the type of notification. Indicates whether it is related to the originating or the terminating user in the call.

Name

Value

Description

P_ORIGINATING

1

Indicates that the notification is related to the originating user in the call.

P_TERMINATING

2

Indicates that the notification is related to the terminating user in the call.

8.3.2.6 TpCallEventInfo

Defines the Sequence of Data Elements that specify the information returned to the application in a New Call event notification.

Sequence Element Name

Sequence Element Type

DestinationAddress

TpAddress

OriginatingAddress

TpAddress

OriginalDestinationAddress

TpAddress

RedirectingAddress

TpAddress

CallAppInfo

TpCallAppInfoSet

CallEventName

TpCallEventName

CallNotificationType

TpCallNotificationType

MonitorMode

TpCallMonitorMode

8.3.3 Generic Call Control Type definitions

8.3.3.1 TpCallAlertingMechanism

This data type is identical to a TpInt32, and defines the mechanism that will be used to alert a called party. The values of this data type are operator specific.

8.3.3.2 TpCallAppInfo

Defines the Tagged Choice of Data Elements that specify application-related call information.

Tag Element Type

TpCallAppInfoType

Tag Element Value

Choice Element Type

Choice Element Name

P_CALL_APP_ALERTING_MECHANISM

TpCallAlertingMechanism

CallAppAlertingMechanism

P_CALL_APP_NETWORK_ACCESS_TYPE

TpCallNetworkAccessType

CallAppNetworkAccessType

P_CALL_APP_TELE_SERVICE

TpCallTeleService

CallAppTeleService

P_CALL_APP_BEARER_SERVICE

TpCallBearerService

CallAppBearerService

P_CALL_APP_PARTY_CATEGORY

TpCallPartyCategory

CallAppPartyCategory

P_CALL_APP_PRESENTATION_ADDRESS

TpAddress

CallAppPresentationAddress

P_CALL_APP_GENERIC_INFO

TpString

CallAppGenericInfo

P_CALL_APP_ADDITIONAL_ADDRESS

TpAddress

CallAppAdditionalAddress

CallAppPresentationAddress contains presentation address.

CallAppGenericInfo contains operator specific information.

CallAppAdditionalAddress contains additional address.

8.3.3.3 TpCallAppInfoType

Defines the type of application related call information.

Name

Value

Description

P_CALL_APP_UNDEFINED

0

Undefined

P_CALL_APP_ALERTING_MECHANISM

1

The alerting mechanism or pattern to use

P_CALL_APP_NETWORK_ACCESS_TYPE

2

The network access type (e.g. ISDN)

P_CALL_APP_TELE_SERVICE

3

Indicates the tele-service (e.g. speech) and related info such as clearing programme

P_CALL_APP_BEARER_SERVICE

4

Indicates the bearer service (e.g. 64kb/s unrestricted data).

P_CALL_APP_PARTY_CATEGORY

5

The category of the calling or called party

P_CALL_APP_PRESENTATION_ADDRESS

6

The address to be presented to other call parties

P_CALL_APP_GENERIC_INFO

7

Carries unspecified application-Service Capability Feature information

P_CALL_APP_ADDITIONAL_ADDRESS

8

Indicates an additional address

8.3.3.4 TpCallAppInfoSet

Defines a Numbered Set of Data Elements of TpCallAppInfo.

8.3.3.5 TpCallBearerService

This data type defines the type of call application-related specific information (Q.931: Information Transfer Capability, and 3GPP TS 22.002)

Name

Value

Description

P_CALL_BEARER_SERVICE_UNKNOWN

0

Bearer capability information unknown at this time

P_CALL_BEARER_SERVICE_SPEECH

1

Speech

P_CALL_BEARER_SERVICE_DIGITALUNRESTRICTED

2

Unrestricted digital information

P_CALL_BEARER_SERVICE_ DIGITALRESTRICTED

3

Restricted digital information

P_CALL_BEARER_SERVICE_AUDIO

4

3.1 kHz audio

P_CALL_BEARER_SERVICE_ DIGITALUNRESTRICTEDTONES

5

Unrestricted digital information with tones/announcements

P_CALL_BEARER_SERVICE_VIDEO

6

Video

8.3.3.6 TpCallChargePlan

Defines the Sequence of Data Elements that specify the charge plan for the call.

Sequence Element Name

Sequence Element Type

Description

ChargeOrderType

TpCallChargeOrder

Charge order

Currency

TpString

Currency unit according to ISO-4217:1995

AdditionalInfo

TpString

Descriptive string which is sent to the billing system without prior evaluation. Could be included in the ticket.

Valid Currencies are:

ADP, AED, AFA, ALL, AMD, ANG, AON, AOR, ARS, ATS, AUD, AWG, AZM, BAM,

BBD, BDT, BEF, BGL, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN,

BWP, BYB, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUP, CVE, CYP,

CZK, DEM, DJF, DKK, DOP, DZD, ECS, ECV, EEK, EGP, ERN, ESP, ETB, EUR,

FIM, FJD, FKP, FRF, GBP, GEL, GHC, GIP, GMD, GNF, GRD, GTQ, GWP, GYD,

HKD, HNL, HRK, HTG, HUF, IDR, IEP, ILS, INR, IQD, IRR, ISK, ITL, JMD,

JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR,

LRD, LSL, LTL, LUF, LVL, LYD, MAD, MDL, MGF, MKD, MMK, MNT, MOP, MRO,

MTL, MUR, MVR, MWK, MXN, MXV, MYR, MZM, NAD, NGN, NIO, NLG, NOK, NPR,

NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PTE, PYG, QAR, ROL, RUB, RUR,

RWF, SAR, SBD, SCR, SDD, SEK, SGD, SHP, SIT, SKK, SLL, SOS, SRG, STD,

SVC, SYP, SZL, THB, TJR, TMM, TND, TOP, TPE, TRL, TTD, TWD, TZS, UAH,

UGX, USD, USN, USS, UYU, UZS, VEB, VND, VUV, WST, XAF, XAG, XAU, XBA,

XBB, XBC, XBD, XCD, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER,

YUM, ZAL, ZAR, ZMK, ZRN, ZWD.

XXX is used for transactions where no currency is involved.

8.3.3.7 TpCallChargeOrder

Defines the Tagged Choice of Data Elements that specify the charge plan for the call.

Tag Element Type

TpCallChargeOrderCategory

Tag Element Value

Choice Element Type

Choice Element Name

P_CALL_CHARGE_PER_TIME

TpChargePerTime

ChargePerTime

P_CALL_CHARGE_NETWORK

TpString

NetworkCharge

8.3.3.8 TpCallChargeOrderCategory

Name

Value

Description

P_CALL_CHARGE_PER_TIME

0

Charge per time

P_CALL_CHARGE_NETWORK

1

Operator specific charge plan specification, e.g. charging table name / charging table entry

8.3.3.9 TpCallEndedReport

Defines the Sequence of Data Elements that specify the reason for the call ending.

Sequence Element Name

Sequence Element Type

CallLegSessionID

TpSessionID

The leg that initiated the release of the call.

If the call release was not initiated by the leg, then this value is set to –1.

Cause

TpCallReleaseCause

The cause of the call ending.

8.3.3.10 TpCallError

Defines the Sequence of Data Elements that specify the additional information relating to an undefined call error.

Sequence Element Name

Sequence Element Type

ErrorTime

TpDateAndTime

ErrorType

TpCallErrorType

AdditionalErrorInfo

TpCallAdditionalErrorInfo

8.3.3.11 TpCallAdditionalErrorInfo

Defines the Tagged Choice of Data Elements that specify additional call error and call error specific information. This is also used to specify call leg errors and call information errors.

Tag Element Type

TpCallErrorType

Tag Element Value

Choice Element Type

Choice Element Name

P_CALL_ERROR_UNDEFINED

NULL

Undefined

P_CALL_ERROR_INVALID_ADDRESS

TpAddressError

CallErrorInvalidAddress

P_CALL_ERROR_INVALID_STATE

NULL

Undefined

8.3.3.12 TpCallErrorType

Defines a specific call error.

Name

Value

Description

P_CALL_ERROR_UNDEFINED

0

Undefined; the method failed or was refused, but no specific reason can be given.

P_CALL_ERROR_INVALID_ADDRESS

1

The operation failed because an invalid address was given

P_CALL_ERROR_INVALID_STATE

2

The call was not in a valid state for the requested operation

8.3.3.13 TpCallFault

Defines the cause of the call fault detected.

Name

Value

Description

P_CALL_FAULT_UNDEFINED

0

Undefined

P_TIMEOUT_ON_RELEASE

1

This fault occurs when the final report has been sent to the application, but the application did not explicitly release or deassign the call object, within a specified time.

The timer value is operator specific.

P_TIMEOUT_ON_INTERRUPT

2

This fault occurs when the application did not instruct the gateway how to handle the call within a specified time, after the gateway reported an event that was requested by the application in interrupt mode.

The timer value is operator specific.

8.3.3.14 TpCallIdentifier

Defines the Sequence of Data Elements that unambiguously specify the Generic Call object

Sequence Element Name

Sequence Element Type

Sequence Element Description

CallReference

IpCallRef

This element specifies the interface reference for the call object.

CallSessionID

TpSessionID

This element specifies the call session ID of the call.

8.3.3.15 TpCallIdentifierRef

Defines a Reference to type TpCallIdentifier.

8.3.3.16 TpCallInfoReport

Defines the Sequence of Data Elements that specify the call information requested. Information that was not requested is invalid.

Sequence Element Name

Sequence Element Type

Description

CallInfoType

TpCallInfoType

The type of call report.

CallInitiationStartTime

TpDateAndTime

The time and date when the call, or follow-on call, was started.

CallConnectedToResourceTime

TpDateAndTime

The date and time when the call was connected to the resource. This data element is only valid where information on user interaction is reported.

CallConnectedToDestinationTime

TpDateAndTime

The date and time when the call was connected to the destination (i.e. when the destination answered the call). If the destination did not answer the time is set to an empty string.

This data element is invalid where information on user interaction is reported with an intermediate report.

CallEndTime

TpDateAndTime

The date and time when the call, follow-on call or user-interaction was terminated.

Cause

TpCallReleaseCause

The cause of call termination.

8.3.3.17 TpCallInfoType

Defines the type of call information requested and reported. The values may be combined by a logical ‘OR’ function.

Name

Value

Description

P_CALL_INFO_UNDEFINED

00h

Undefined

P_CALL_INFO_TIMES

01h

Relevant call times

P_CALL_INFO_RELEASE_CAUSE

02h

Call release cause

P_CALL_INFO_INTERMEDIATE

04h

Send only intermediate reports. When this is not specified the information report will only be sent when the call has ended. When intermediate reports are requested a report will be generated between follow-on calls, i.e. when a party leaves the call.

8.3.3.18 TpCallMonitorMode

Defines the mode that the call will monitor for events, or the mode that the call is in following a detected event.

Name

Value

Description

P_CALL_MONITOR_MODE_INTERRUPT

0

The call event is intercepted by the call control SCF and call processing is interrupted. The application is notified of the event and call processing resumes following an appropriate API call or network event (such as a call release)

P_CALL_MONITOR_MODE_NOTIFY

1

The call event is detected by the call control SCF but not intercepted. The application is notified of the event and call processing continues

P_CALL_MONITOR_MODE_DO_NOT_MONITOR

2

Do not monitor for the event

8.3.3.19 TpCallNetworkAccessType

This data defines the bearer capabilities associated with the call. (3GPP TS 24.002) This information is network operator specific and may not always be available because there is no standard protocol to retrieve the information.

Name

Value

Description

P_CALL_NETWORK_ACCESS_TYPE_UNKNOWN

0

Network type information unknown at this time

P_CALL_NETWORK_ACCESS_TYPE_POT

1

POTS

P_CALL_NETWORK_ACCESS_TYPE_ISDN

2

ISDN

P_CALL_NETWORK_ACCESS_TYPE_DIALUPINTERNET

3

Dial-up Internet

P_CALL_NETWORK_ACCESS_TYPE_XDSL

4

xDSL

P_CALL_NETWORK_ACCESS_TYPE_WIRELESS

5

Wireless

8.3.3.20 TpCallOverloadType

Defines the type of call overload that has been detected (and possibly acted upon) by the network.

Name

Value

Description

P_CALL_OVERLOAD_TYPE_UNDEFINED

0

Infinite interval

(do not admit any calls)

P_CALL_OVERLOAD_TYPE_NEW_CALLS

1

New calls to the application are causing overload (i.e. inbound overload)

P_CALL_OVERLOAD_TYPE_ROUTED_CALLS

2

Calls being routed to destination or origination addresses by the application are causing overload (i.e. outbound overload)

8.3.3.21 TpCallServiceCode

Defines the Sequence of Data Elements that specify the service code and type of service code received during a call. The service code type defines how the value string should be interpreted.

Sequence Element Name

Sequence Element Type

CallServiceCodeType

TpCallServiceCodeType

ServiceCodeValue

TpString

8.3.3.22 TpCallServiceCodeType

Defines the different types of service codes that can be received during the call.

Name

Value

Description

P_CALL_SERVICE_CODE_UNDEFINED

0

The type of service code is unknown. The corresponding string is operator specific.

P_CALL_SERVICE_CODE_DIGITS

1

The user entered a digit sequence during the call. The corresponding string is an ascii representation of the received digits.

P_CALL_SERVICE_CODE_FACILITY

2

A facility information element is received. The corresponding string contains the facility information element as defined in ITU Q.932

P_CALL_SERVICE_CODE_U2U

3

A user-to-user message was received. The associated string contains the content of the user-to-user information element.

P_CALL_SERVICE_CODE_HOOKFLASH

4

The user performed a hookflash, optionally followed by some digits. The corresponding string is an ascii representation of the entered digits.

P_CALL_SERVICE_CODE_RECALL

5

The user pressed the register recall button, optionally followed by some digits. The corresponding string is an ascii representation of the entered digits.

8.3.3.23 TpCallPartyCategory

This data type defines the category of a calling party. (Q.763: Calling Party Category / Called Party Category)

Name

Value

Description

P_CALL_PARTY_CATEGORY_UNKNOWN

0

calling party’s category unknown at this time

P_CALL_PARTY_CATEGORY_OPERATOR_F

1

operator, language French

P_CALL_PARTY_CATEGORY_OPERATOR_E

2

operator, language English

P_CALL_PARTY_CATEGORY_OPERATOR_G

3

operator, language German

P_CALL_PARTY_CATEGORY_OPERATOR_R

4

operator, language Russian

P_CALL_PARTY_CATEGORY_OPERATOR_S

5

operator, language Spanish

P_CALL_PARTY_CATEGORY_ORDINARY_SUB

6

ordinary calling subscriber

P_CALL_PARTY_CATEGORY_PRIORITY_SUB

7

calling subscriber with priority

P_CALL_PARTY_CATEGORY_DATA_CALL

8

data call (voice band data)

P_CALL_PARTY_CATEGORY_TEST_CALL

9

test call

P_CALL_PARTY_CATEGORY_PAYPHONE

10

payphone

8.3.3.24 TpCallReleaseCause

Defines the Sequence of Data Elements that specify the cause of the release of a call.

Sequence Element Name

Sequence Element Type

Value

TpInt32

Location

TpInt32

Note: the Value and Location are specified as in ITU-T recommendation Q.850.

8.3.3.25 TpCallReport

Defines the Sequence of Data Elements that specify the call report and call leg report specific information.

Sequence Element Name

Sequence Element Type

MonitorMode

TpCallMonitorMode

CallEventTime

TpDateAndTime

CallReportType

TpCallReportType

AdditionalReportInfo

TpCallAdditionalReportInfo

8.3.3.26 TpCallAdditionalReportInfo

Defines the Tagged Choice of Data Elements that specify additional call report information for certain types of reports.

Tag Element Type

TpCallReportType

Tag Element Value

Choice Element Type

Choice Element Name

P_CALL_REPORT_UNDEFINED

NULL

Undefined

P_CALL_REPORT_PROGRESS

NULL

Undefined

P_CALL_REPORT_ALERTING

NULL

Undefined

P_CALL_REPORT_ANSWER

NULL

Undefined

P_CALL_REPORT_BUSY

TpCallReleaseCause

Busy

P_CALL_REPORT_NO_ANSWER

NULL

Undefined

P_CALL_REPORT_DISCONNECT

TpCallReleaseCause

CallDisconnect

P_CALL_REPORT_REDIRECTED

TpAddress

ForwardAddress

P_CALL_REPORT_SERVICE_CODE

TpCallServiceCode

ServiceCode

P_CALL_REPORT_ROUTING_FAILURE

TpCallReleaseCause

RoutingFailure

8.3.3.27 TpCallReportRequest

Defines the Sequence of Data Elements that specify the criteria relating to call report requests.

Sequence Element Name

Sequence Element Type

MonitorMode

TpCallMonitorMode

CallReportType

TpCallReportType

AdditionalReportcriteria

TpCallAdditionalReportCriteria

8.3.3.28 TpCallAdditionalReportCriteria

Defines the Tagged Choice of Data Elements that specify specific criteria.

Tag Element Type

TpCallReportType

Tag Element Value

Choice Element Type

Choice Element Name

P_CALL_REPORT_UNDEFINED

NULL

Undefined

P_CALL_REPORT_PROGRESS

NULL

Undefined

P_CALL_REPORT_ALERTING

NULL

Undefined

P_CALL_REPORT_ANSWER

NULL

Undefined

P_CALL_REPORT_BUSY

NULL

Undefined

P_CALL_REPORT_NO_ANSWER

TpDuration

NoAnswerDuration

P_CALL_REPORT_DISCONNECT

NULL

Undefined

P_CALL_REPORT_REDIRECTED

NULL

Undefined

P_CALL_REPORT_SERVICE_CODE

TpCallServiceCode

ServiceCode

P_CALL_REPORT_ROUTING_FAILURE

NULL

Undefined

8.3.3.29 TpCallReportRequestSet

Defines a Numbered Set of Data Elements of TpCallReportRequest.

8.3.3.30 TpCallReportType

Defines a specific call event report type.

Name

Value

Description

P_CALL_REPORT_UNDEFINED

0

Undefined

P_CALL_REPORT_PROGRESS

1

Call routing progress event: an indication from the network that progress has been made in routing the call to the requested called party.

P_CALL_REPORT_ALERTING

2

Call is alerting at the called party.

P_CALL_REPORT_ANSWER

3

Call answered at address

P_CALL_REPORT_BUSY

4

Called address refused call due to busy

P_CALL_REPORT_NO_ANSWER

5

No answer at called address

P_CALL_REPORT_DISCONNECT

6

The called party has disconnected.

P_CALL_REPORT_REDIRECTED

7

Call redirected to new address: an indication from the network that the call has been redirected to a new address.

P_CALL_REPORT_SERVICE_CODE

8

Mid-call service code received

P_CALL_REPORT_ROUTING_FAILURE

9

Call routing failed – re-routing is possible

8.3.3.31 TpCallTeleService

This data type defines the tele-service associated with the call. (Q.763: User Teleservice Information, Q.931: High Layer Compatitibility Information, and 3GPP TS 22.003)

Name

Value

Description

P_CALL_TELE_SERVICE_UNKNOWN

0

Teleservice information unknown at this time

P_CALL_TELE_SERVICE_TELEPHONY

1

Telephony

P_CALL_TELE_SERVICE_FAX_2_3

2

Facsimile Group 2/3

P_CALL_TELE_SERVICE_FAX_4_I

3

Facsimile Group 4, Class I

P_CALL_TELE_SERVICE_FAX_4_II_III

4

Facsimile Group 4, Classes II and III

P_CALL_TELE_SERVICE_VIDEOTEX_SYN

5

Syntax based Videotex

P_CALL_TELE_SERVICE_VIDEOTEX_INT

6

International Videotex interworking via gateways or interworking units

P_CALL_TELE_SERVICE_TELEX

7

Telex service

P_CALL_TELE_SERVICE_MHS

8

Message Handling Systems

P_CALL_TELE_SERVICE_OSI

9

OSI application

P_CALL_TELE_SERVICE_FTAM

10

FTAM application

P_CALL_TELE_SERVICE_VIDEO

11

Videotelephony

P_CALL_TELE_SERVICE_VIDEO_CONF

12

Videoconferencing

P_CALL_TELE_SERVICE_AUDIOGRAPH_CONF

13

Audiographic conferencing

P_CALL_TELE_SERVICE_MULTIMEDIA

14

Multimedia services

P_CALL_TELE_SERVICE_CS_INI_H221

15

Capability set of initial channel of H.221

P_CALL_TELE_SERVICE_CS_SUB_H221

16

Capability set of subsequent channel of H.221

P_CALL_TELE_SERVICE_CS_INI_CALL

17

Capability set of initial channel associated with an active 3.1 kHz audio or speech call.

P_CALL_TELE_SERVICE_DATATRAFFIC

18

Data traffic.

P_CALL_TELE_SERVICE_EMERGENCY_CALLS

19

Emergency Calls

P_CALL_TELE_SERVICE_SMS_MT_PP

20

Short message MT/PP

P_CALL_TELE_SERVICE_SMS_MO_PP

21

Short message MO/PP

P_CALL_TELE_SERVICE_CELL_BROADCAST

22

Cell Broadcast Service

P_CALL_TELE_SERVICE_ALT_SPEECH_FAX_3

23

Alternate speech and facsimile group 3

P_CALL_TELE_SERVICE_AUTOMATIC_FAX_3

24

Automatic Facsimile group 3

P_CALL_TELE_SERVICE_VOICE_GROUP_CALL

25

Voice Group Call Service

P_CALL_TELE_SERVICE_VOICE_BROADCAST

26

Voice Broadcast Service

8.3.3.32 TpCallSuperviseReport

Defines the responses from the call control SCF for calls that are supervised. The values may be combined by a logical ‘OR’ function.

Name

Value

Description

P_CALL_SUPERVISE_TIMEOUT

01h

The call supervision timer has expired

P_CALL_SUPERVISE_CALL_ENDED

02h

The call has ended, either due to timer expiry or call party release. In case the called party disconnects but a follow-on call can still be made also this indication is used.

P_CALL_SUPERVISE_TONE_APPLIED

04h

A warning tone has been applied This is only sent in combination with P_CALL_SUPERVISE_TIMEOUT.

P_CALL_SUPERVISE_UI_FINISHED

08h

The user interaction has finished.

8.3.3.33 TpCallSuperviseTreatment

Defines the treatment of the call by the call control SCF when the call supervision timer expires. The values may be combined by a logical ‘OR’ function.

Name

Value

Description

P_CALL_SUPERVISE_RELEASE

01h

Release the call when the call supervision timer expires

P_CALL_SUPERVISE_RESPOND

02h

Notify the application when the call supervision timer expires

P_CALL_SUPERVISE_APPLY_TONE

04h

Send a warning tone to the controlling party when the call supervision timer expires. If call release is requested, then the call will be released following the tone after an administered time period.

8.4 User Interaction Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.guis package.

8.4.1 Interface definitions

8.4.1.1 IpUI

Defines the address of an IUI Interface.

8.4.1.2 IpUIRef

Defines a Reference to type IUI.

8.4.1.3 IpUIRefRef

Defines a Reference to type IUIRef.

8.4.1.4 IpUIManager

Defines the address of an IUIManager Interface.

8.4.1.5 IpUIManagerRef

Defines a Reference to type IUIManager.

8.4.1.6 IpAppUI

Defines the address of an IAppUI Interface.

8.4.1.7 IpAppUIRef

Defines a Reference to type IAppUI.

8.4.1.8 IpAppUIRefRef

Defines a Reference to type IAppUIRef.

8.4.1.9 IpAppUIManager

Defines the address of an IAppUIManager Interface.

8.4.1.10 IpAppUIManagerRef

Defines a Reference to type IAppUIManager.

8.4.2 Type definitions

8.4.2.1 TpUICallIdentifier

Defines the Sequence of Data Elements that unambiguously specify the UICall object

Structure Element Name

Structure Element Type

Structure Element Description

UICallRef

IpUICallRef

This element specifies the interface reference for the UICall object.

UserInteractionSessionID

TpSessionID

This element specifies the user interaction session ID.

8.4.2.2 TpUICallIdentifierRef

Defines a reference to type TpUICallIdentifier.

8.4.2.3 TpUICollectCriteria

Defines the Sequence of Data Elements that specify the additional properties for the collection of information, such as the end character, first character timeout, inter-character timeout, and maximum interaction time.

Structure Element Name

Structure Element Type

MinLength

TpInt32

MaxLength

TpInt32

EndSequence

TpString

StartTimeout

TpDuration

InterCharTimeout

TpDuration

The structure elements specify the following criteria:

MinLength: Defines the minimum number of characters (e.g. digits) to collect.

MaxLength: Defines the maxmum number of characters (e.g. digits) to collect.

EndSequence: Defines the character or characters which terminate an input of variable length, e.g. phonenumbers.

StartTimeout: specifies the value for the first character time-out timer. The timer is started when the announcement has been completed or has been interrupted. The user should enter the start of the response (e.g. first digit) before the timer expires. If the start of the response is not entered before the timer expires, the input is regarded to be erroneous. After receipt of the start of the response, which may be valid or invalid, the timer is stopped.

InterCharTimeOut: specifies the value for the inter-character time-out timer.The timer is started when a response (e.g. digit) is received, and is reset and restarted when a subsequent response is received. The responses may be valid or invalid. the announcement has been completed or has been interrupted.

Input is considered successful if the following applies:

If the EndSequence is not present (i.e. NULL):

– when the InterCharTimeOut timer expires; or

– when the number of valid digits received equals the MaxLength.

If the EndSequence is present:

– when the InterCharTimeOut timer expires; or

– when the EndSequence is received; or

– when the number of valid digits received equals the MaxLength.

In the case the number of valid characters received is less than the MinLength when the InterCharTimeOut timer expires or when the EndSequence is received, the input is considered erroneous.

The collected characters (including the EndSequence) are sent to the client application when input hs been successful.

8.4.2.4 TpUIError

Defines the UI call error codes.

Name

Value

Description

P_UI_ERROR_UNDEFINED

0

Undefined error

P_UI_ERROR_ILLEGAL_ID

1

The information id specified is invalid

P_UI_ERROR_ID_NOT_FOUND

2

A legal information id is not known to the the User Interaction SCF

P_UI_ERROR_RESOURCE_UNAVAILABLE

3

The information resources used by the User Interaction SCF are unavailable, e.g. due to an overload situation.

P_UI_ERROR_ILLEGAL_RANGE

4

The values for minimum and maximum collection length are out of range

P_UI_ERROR_IMPROPER_CALLER_RESPONSE

5

Improper user response

P_UI_ERROR_ABANDON

6

The specified leg is disconnected before the send information completed

P_UI_ERROR_NO_OPERATION_ACTIVE

7

There is no active user interaction for the specified leg. Either the application did not start any user interaction or the user interaction was already finished when the abortAction_Req() was called.

P_UI_ERROR_NO_SPACE_AVAILABLE

8

There is no more storage capacity to record the message when the recordMessage() operation was called

The call user interaction object will be automatically de-assigned if the error P_UI_ERROR_ABANDON is reported, as a corresponding call or call leg object no longer exists.

8.4.2.5 TpUIEventCriteria

Defines the Sequence of Data Elements that specify the additional criteria for receiving a UI notification

Structure Element Name

Structure Element Type

Description

OriginatingAddress

TpAddressRange

Defines the originating address for which the notification is requested.

DestinationAddress

TpAddressRange

Defines the destination address or address range for which the notification is requested.

ServiceCode

TpString

Defines a 2 digit code indicating the UI to be triggered. The value is operator specific.

8.4.2.6 TpUIEventInfo

Defines the Sequence of Data Elements that specify a UI notification

Structure Element Name

Structure Element Type

OriginatingAddress

TpAddress

Defines the originating address.

DestinationAddress

TpAddress

Defines the destination address.

ServiceCode

TpString

Defines a 2 digit code indicating the UI to be triggered. The value is operator specific.

DataTypeIndication

TpUIEventInfoDataType

Identifies the type of contents in the dataString.

DataString

TpString

Freely defined data string with a limited length e.g. 160 bytes according to the network policy.

8.4.2.7 TpUIEventInfoDataType

Defines the type of the dataString parameter in the method userInteractionEventNotify.

Name

Value

Description

P_UI_EVENT_DATA_TYPE_UNDEFINED

0

Undefined (e.g. binary data)

P_UI_EVENT_DATA_TYPE_UNSPECIFIED

1

Unspecified data

P_UI_EVENT_DATA_TYPE_TEXT

2

Text

P_UI_EVENT_DATA_TYPE_USSD_DATA

3

USSD data starting with coding scheme

8.4.2.8 TpUIFault

Defines the cause of the UI fault detected.

Name

Value

Description

P_UI_FAULT_UNDEFINED

0

Undefined

P_UI_CALL_DEASSIGNED

1

The related Call object has been deassigned. No further interaction is possible. Already requested announcements will continue but no requested reports will be send to the application.

8.4.2.9 TpUIIdentifier

Defines the Sequence of Data Elements that unambiguously specify the UI object

Structure Element Name

Structure Element Type

Structure Element Description

UIRef

IpUIRef

This element specifies the interface reference for the UI object.

UserInteractionSessionID

TpSessionID

This element specifies the user interaction session ID.

8.4.2.10 TpUIIdentifierRef

Defines a reference to type TpUIIdentifier.

8.4.2.11 TpUIInfo

Defines the Tagged Choice of Data Elements that specify the information to send to the user.

Tag Element Type

TpUIInfoType

Tag Element Value

Choice Element Type

Choice Element Name

P_UI_INFO_ID

TpInt32

InfoId

P_UI_INFO_DATA

TpString

InfoData

P_UI_INFO_ADDRESS

TpURL

InfoAddress

The choice elements represents the following:

InfoID: defines the ID of the user information script or stream to send to an end-user. The values of this data type are operator specific.

InfoData: defines the data to be sent to an end-user’s terminal. The data is free-format and the encoding is depending on the resources being used..

InfoAddress: defines the URL of the text or stream to be sent to an end-user’s terminal.

8.4.2.12 TpUIInfoType

Defines the type of the information to be sent to the user.

Name

Value

Description

P_UI_INFO_ID

1

The information to be send to an end-user consists of an ID

P_UI_INFO_DATA

2

The information to be send to an end-user consists of a data string

P_UI_INFO_ADDRESS

3

The information to be send to an end-user consists of a URL.

8.4.2.13 TpUIReport

Defines the UI call reports if a response was requested.

Name

Value

Description

P_UI_REPORT_UNDEFINED

0

Undefined report

P_UI_REPORT_ANNOUNCEMENT_ENDED

1

Confirmation that the announcement has ended

P_UI_REPORT_LEGAL_INPUT

2

Information collected., meeting the specified criteria.

P_UI_REPORT_NO_INPUT

3

No information collected. The user immediately entered the delimiter character. No valid information has been returned

P_UI_REPORT_TIMEOUT

4

No information collected. The user did not input any response before the input timeout expired

P_UI_REPORT_MESSAGE_STORED

5

A message has been stored successfully

P_UI_REPORT_MESSAGE_NOT_STORED

6

The message has not been stored successfully

8.4.2.14 TpUIResponseRequest

Defines the situations for which a response is expected following the user interaction.

Name

Value

Description

P_UI_RESPONSE_REQUIRED

1

The User Interaction Call must send a response when the request has completed.

P_UI_LAST_ANNOUNCEMENT_IN_A_ROW

2

This is the final announcement within a sequence. It might, however, be that additional announcements will be requested at a later moment. The Call User Interaction Call SCF may release any used resources in the network. The UI object will not be released.

P_UI_FINAL_REQUEST

4

This is the final request. The UI object will be released after the information has been presented to the user.

This parameter represent a bitmask, i.e. the values can be added to derived the final meaning.

8.4.2.15 TpUIVariableInfo

Defines the Tagged Choice of Data Elements that specify the variable parts in the information to send to the user.

Tag Element Type

TpUIVariablePartType

Tag Element Value

Choice Element Type

Choice Element Name

P_UI_VARIABLE_PART_INT

TpInt32

VariablePartInteger

P_UI_VARIABLE_PART_ADDRESS

TpString

VariablePartAddress

P_UI_VARIABLE_PART_TIME

TpTime

VariablePartTime

P_UI_VARIABLE_PART_DATE

TpDate

VariablePartDate

P_UI_VARIABLE_PART_PRICE

TpPrice

VariablePartPrice

8.4.2.16 TpUIVariableInfoSet

Defines a Numbered Set of Data Elements of TpUIVariableInfo.

8.4.2.17 TpUIVariablePartType

Defines the type of the variable parts in the information to send to the user.

Name

Value

Description

P_UI_VARIABLE_PART_INT

0

Variable part is of type integer

P_UI_VARIABLE_PART_ADDRESS

1

Variable part is of type address

P_UI_VARIALBE_PART_TIME

2

Variable part is of type time

P_UI_VARIABLE_PART_DATE

3

Variable part is of type date

P_UI_VARIABLE_PART_PRICE

4

Variable part is of type price

8.5 Data Session Control Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.dscs package.

8.5.1 Interface definitions

8.5.1.1 IpAppDataSession

Defines the address of an IpAppDataSession Interface.

8.5.1.2 IpAppDataSessionRef

Defines a Reference to type IpAppDataSession

8.5.1.3 IpAppDataSessionRefRef

Defines a Reference to type IpAppDataSessionRef.

8.5.1.4 IpAppDataSessionControlManager

Defines the address of an IpAppDataSessionControlManager Interface.

8.5.1.5 IpAppDataSessionControlManagerRef

Defines a Reference to type IpAppDataSessionControlManager.

8.5.1.6 IpDataSession

Defines the address of an IpDataSession Interface.

8.5.1.7 IpDataSessionRef

Defines a Reference to type IpDataSession.

8.5.1.8 IpDataSessionRefRef

Defines a Reference to type IpDataSessionRef.

8.5.1.9 IpDataSessionControlManager

Defines the address of an IpDataSessionManager Interface.

8.5.1.10 IpDataSessionManagerRef

Defines a Reference to type IpDataSessionControlManager.

8.5.2 Event Notification data definitions

8.5.2.1 TpDataSessionEventName

Defines the names of events being notified with a new call request. The following events are supported. The values may be combined by a logical ‘OR’ function when requesting the notifications. Additional events that can be requested / received during the call process are found in the TpDataSessionReportType data-type.

Name

Value

Description

P_EVENT_NAME_UNDEFINED

0

Undefined

P_EVENT_DSCS_SETUP

1

The data session is going to be setup.

P_EVENT_DSCS_ESTABLISHED

2

The data session is established by the network.

8.5.2.2 TpDataSessionMonitorMode

Defines the mode that the call will monitor for events, or the mode that the call is in following a detected event.

Name

Value

Description

P_DATA_SESSION_MONITOR_MODE_INTERRUPT

0

The data session event is intercepted by the data session control service and data session establishment is interrupted. The application is notified of the event and data session establishement resumes following an appropriate API call or network event (such as a data session release)

P_DATA_SESSION_MONITOR_MODE_NOTIFY

1

The data session event is detected by the data session control service but not intercepted. The application is notified of the event and data session establishment continues

P_DATA_SESSION_MONITOR_MODE_DO_NOT_MONITOR

2

Do not monitor for the event

8.5.2.3 TpDataSessionEventCriteria

Defines the Sequence of Data Elements that specify the criteria for a event notification.

Of the addresses only the Plan and the AddrString are used for the purpose of matching the notifications against the criteria.

Sequence Element Name

Sequence Element Type

Description

DestinationAddress

TpAddressRange

Defines the destination address or address range for which the notification is requested.

OriginatingAddress

TpAddressRange

Defines the origination address or a address range for which the notification is requested.

DataSessionEventName

TpDataSessionEventName

Name of the event(s)

MonitorMode

TpDataSessionMonitorMode

Defines the mode that the Data Session is in following the notification.
Monitor mode P_DATA_SESSION_MONITOR_MODE_DO_NOT_MONITOR is not a legal value here.

8.5.2.4 TpDataSessionEventInfo

Defines the Sequence of Data Elements that specify the information returned to the application in a Data Session event notification.

Sequence Element Name

Sequence Element Type

DestinationAddress

TpAddress

OriginatingAddress

TpAddress

DataSessionEventName

TpDataSessionEventName

MonitorMode

TpDataSessionMonitorMode

8.5.2.5 TpDataSessionChargePlan

Defines the Sequence of Data Elements that specify the charge plan for the call.

Sequence Element Name

Sequence Element Type

Description

ChargeOrderType

TpDataSessionChargeOrder

Charge order

Currency

TpString

Currency unit according to ISO-4217:1995

AdditionalInfo

TpString

Descriptive string which is sent to the billing system without prior evaluation. Could be included in the ticket.

Valid Currencies are:

ADP, AED, AFA, ALL, AMD, ANG, AON, AOR, ARS, ATS, AUD, AWG, AZM, BAM,

BBD, BDT, BEF, BGL, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN,

BWP, BYB, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUP, CVE, CYP,

CZK, DEM, DJF, DKK, DOP, DZD, ECS, ECV, EEK, EGP, ERN, ESP, ETB, EUR,

FIM, FJD, FKP, FRF, GBP, GEL, GHC, GIP, GMD, GNF, GRD, GTQ, GWP, GYD,

HKD, HNL, HRK, HTG, HUF, IDR, IEP, ILS, INR, IQD, IRR, ISK, ITL, JMD,

JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR,

LRD, LSL, LTL, LUF, LVL, LYD, MAD, MDL, MGF, MKD, MMK, MNT, MOP, MRO,

MTL, MUR, MVR, MWK, MXN, MXV, MYR, MZM, NAD, NGN, NIO, NLG, NOK, NPR,

NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PTE, PYG, QAR, ROL, RUB, RUR,

RWF, SAR, SBD, SCR, SDD, SEK, SGD, SHP, SIT, SKK, SLL, SOS, SRG, STD,

SVC, SYP, SZL, THB, TJR, TMM, TND, TOP, TPE, TRL, TTD, TWD, TZS, UAH,

UGX, USD, USN, USS, UYU, UZS, VEB, VND, VUV, WST, XAF, XAG, XAU, XBA,

XBB, XBC, XBD, XCD, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER,

YUM, ZAL, ZAR, ZMK, ZRN, ZWD.

XXX is used for transactions where no currency is involved.

8.5.2.6 TpDataSessionChargeOrder

Defines the Tagged Choice of Data Elements that specify the charge plan for the call.

Tag Element Type

TpDataSessionChargeOrderCategory

Tag Element Value

Choice Element Type

Choice Element Name

P_DATA_SESSION_CHARGE_PER_VOLUME

TpChargePerVolume

ChargePerVolume

P_DATA_SESSION_CHARGE_NETWORK

TpString

NetworkCharge

8.5.2.7 TpDataSessionChargeOrderCategory

Name

Value

Description

P_DATA_SESSION_CHARGE_PER_VOLUME

0

Charge per volume

P_DATA_SESSION_CHARGE_NETWORK

1

Operator specific charge plan specification, e.g. charging table name / charging table entry

8.5.2.8 TpChargePerVolume

Defines the Sequence of Data Elements that specify the time based charging information. The volume is the sum of uplink and downlink transfer data volumes.

Sequence Element Name

Sequence Element Type

Description

InitialCharge

TpInt32

Initial charge amount (in currency units * 0.0001)

CurrentChargePerKilobyte

TpInt32

Current tariff (in currency units * 0.0001)

NextChargePerKilobyte

TpInt32

Next tariff (in currency units * 0.0001) after tariff switch.

Only used in setAdviceOfCharge()

8.5.2.9 TpDataSessionIdentifier

Defines the Sequence of Data Elements that unambiguously specify the Data Session object

Sequence Element Name

Sequence Element Type

Sequence Element Description

DataSessionReference

IpDataSessionRef

This element specifies the interface reference for the Data Session object.

DataSessionSessionID

TpSessionID

This element specifies the data session ID of the Data Session.

8.5.2.10 TpDataSessionError

Defines the Sequence of Data Elements that specify the additional information relating to acall error.

Sequence Element Name

Sequence Element Type

ErrorTime

TpDateAndTime

ErrorType

TpDataSessionErrorType

AdditionalErrorInfo

TpDataSessionAdditionalErrorInfo

8.5.2.11 TpDataSessionAdditionalErrorInfo

Defines the Tagged Choice of Data Elements that specify additional Data Session error and Data Session error specific information.

Tag Element Type

TpDataSessionErrorType

Tag Element Value

Choice Element Type

Choice Element Name

P_DATA_SESSION_ERROR_UNDEFINED

NULL

Undefined

P_DATA_SESSION_ERROR_INVALID_ADDRESS

TpAddressError

DataSessionErrorInvalidAddress

P_DATA_SESSION_ERROR_INVALID_STATE

NULL

Undefined

8.5.2.12 TpDataSessionErrorType

Defines a specific Data Session error.

Name

Value

Description

P_DATA_SESSION_ERROR_UNDEFINED

0

Undefined; the method failed or was refused, but no specific reason can be given.

P_DATA_SESSION_ERROR_INVALID_ADDRESS

1

The operation failed because an invalid address was given

P_DATA_SESSION_ERROR_INVALID_STATE

2

The data session was not in a valid state for the requested operation

8.5.2.13 TpDataSessionFault

Defines the cause of the data session fault detected.

Name

Value

Description

P_DATA_SESSION_FAULT_UNDEFINED

0

Undefined

P_DATA_SESION_USER_ABORTED

1

User has finalised the data session before any message could be sent by the application

P_DATA_SESSION_TIMEOUT_ON_RELEASE

2

This fault occurs when the final report has been sent to the application, but the application did not explicitly release data session object, within a specified time.

The timer value is operator specific.

P_DATA_SESSION_TIMEOUT_ON_INTERRUPT

3

This fault occurs when the application did not instruct the gateway how to handle the call within a specified time, after the gateway reported an event that was requested by the application in interrupt mode.

The timer value is operator specific.

8.5.2.14 TpDataSessionReleaseCause

Defines the Sequence of Data Elements that specify the cause of the release of a data session.

Sequence Element Name

Sequence Element Type

Value

TpInt32

Location

TpInt32

Note: the Value and Location are specified as in ITU-T recommendation Q.850.

8.5.2.15 TpDataSessionSuperviseVolume

Defines the Sequence of Data Elements that specify the amount of volume that is allowed to be transmitted for the specific connection.

Sequence Element Name

Sequence Element Type

Sequence Element Description

VolumeQuantity

TpInt32

This data type is identical to a TpInt32, and defines the quantity of the granted volume that can be transmitted for the specific connection. The volume specifies the sum of uplink and downlink transfer data volumes.

VolumeUnit

TpInt32

In Order to enlarge the range of the volume quantity value the exponent of a scaling factor (10^VolumeUnit) is provided.

When the unit is for example in kilobytes, VolumeUnit must be set to 3.

8.5.2.16 TpDataSessionSuperviseReport

Defines the responses from the data session control service for calls that are supervised. The values may be combined by a logical ‘OR’ function.

Name

Value

Description

P_DATA_SESSION_SUPERVISE_VOLUME_REACHED

01h

The maximum volume has been reached.

P_DATA_SESSION_SUPERVISE_DATA_SESSION_ENDED

02h

The data session has ended, either due to data session party to reach of maximum volume or calling or called release.

P_DATA_SESSION_SUPERVISE_MESSAGE_SENT

04h

A warning message has been sent.

8.5.2.17 TpDataSessionSuperviseTreatment

Defines the treatment of the call by the data session control service when the supervised volume is reached. The values may be combined by a logical ‘OR’ function.

Name

Value

Description

P_DATA_SESSION_SUPERVISE_RELEASE

01h

Release the data session when the data session supervision volume is reached.

P_DATA_SESSION_SUPERVISE_RESPOND

02h

Notify the application when the call supervision volume is reached.

P_DATA_SESSION_SUPERVISE_INFORM

04h

Send a warning message to the originating party when the maximum volume is reached. If data session release is requested, then the data session will be released following the message after an administered time period

8.5.2.18 TpDataSessionReport

Defines the Sequence of Data Elements that specify the data session report specific information.

Sequence Element Name

Sequence Element Type

MonitorMode

TpDataSessionMonitorMode

DataSessionEventTime

TpDateAndTime

DataSessionReportType

TpDataSessionReportType

AdditionalReportInfo

TpDataSessionAdditionalReportInfo

8.5.2.19 TpDataSessionAdditionalReportInfo

Defines the Tagged Choice of Data Elements that specify additional data session report information for certain types of reports.

Tag Element Type

TpDataSessionReportType

Tag Element Value

Choice Element Type

Choice Element Name

P_DATA_SESSION_REPORT_UNDEFINED

NULL

Undefined

P_DATA_SESSION_REPORT_CONNECTED

NULL

Undefined

P_DATA_SESSION_REPORT_DISCONNECT

TpDataSessionReleaseCause

DataSessionDisconnect

8.5.2.20 TpDataSessionReportRequest

Defines the Sequence of Data Elements that specify the criteria relating to data session report requests.

Sequence Element Name

Sequence Element Type

MonitorMode

TpDataSessionMonitorMode

DataSessionReportType

TpDataSessionReportType

8.5.2.21 TpDataSessionReportRequestSet

Defines a Numbered Set of Data Elements of TpDataSessionReportRequest.

8.5.2.22 TpDataSessionReportType

Defines a specific data session event report type.

Name

Value

Description

P_DATA_SESSION_REPORT_UNDEFINED

0

Undefined

P_DATA_SESSION_REPORT_CONNECTED

1

Data session established.

P_DATA_SESSION_REPORT_DISCONNECT

2

Data session disconnect requested by data session party

8.5.2.23 TpDataSessionEventCriteriaResultSetRef

Defines a refernce to TpDataSessionEventCriteriaResultSet.

8.5.2.24 TpDataSessionEventCriteriaResultSet

Defines a set of TpDataSessionEventCriteriaResult.

8.5.2.25 TpDataSessionEventCriteriaResult

Defines a sequence of data elements that specify a requested call event notification criteria with the associated assignmentID.

Sequence Element Name

Sequence Element Type

Sequence Element Description

EventCriteria

TpDataSessionEventCriteria

The event criteria that were specified by the application.

AssignmentID

TpInt32

The associated assignementID. This can be used to disable the notification.

8.6 Network User Location and User Status Data definitions

8.6.1 Interface Definitions

8.6.1.1 IpAppUserStatus

Defines the address of an IpAppUserStatus Interface.

8.6.1.2 IpAppUserStatusRef

Defines a reference to type IpAppUserStatus.

8.6.1.3 IpUserStatus

Defines the address of an IpUserStatus Interface.

8.6.1.4 IpAppUserLocationCamel

Defines the address of an IpAppUserLocationCamel Interface.

8.6.1.5 IpAppUserLocationCamelRef

Defines a reference to type IpAppUserLocationCamelRef.

8.6.1.6 IpUserLocationCamel

Defines the address of an IpUserLocationCamel Interface.

8.6.2 Common Data Definitions for Network User Location and User Status

The constants and types defined in the following sections are defined in the org.threegpp.osa.mm package.

8.6.2.1 TpGeographicalPosition

Defines the structure of data elements that specify a geographical position.

An “ellipsoid point with uncertainty shape” defines the horizontal location. The reference system chosen for the coding of locations is the World Geodetic System 1984 (WGS 84).

TypeOfUncertaintyShape describes the type of the uncertainty shape and Longitude/Latitude defines the position of the uncertainty shape. The following table defines the meaning of the data elements that describe the uncertainty shape for each uncertainty shape type.

Type of uncertainty shape

Uncertainty
Outer
Semi
Major

Uncertainty
Outer
Semi
Minor

Uncertainty
Inner
Semi
Major

Uncertainty
Inner
Semi
Minor

Angle Of Semi Major

Segment Start Angle

Segment End Angle

None

Circle

radius of circle

Circle Sector

radius of circle

start angle of circle segment

end angle of circle segment

Circle Arc Stripe

radius of outer circle

radius of inner circle

start angle of circle arc stripe

end angle of circle arc stripe

Ellipse

length of semi-major axis

length of semi-minor axis

rotation of ellipse measured clockwise from north

Ellipse Sector

length of semi-major axis

length of semi-minor axis

rotation of ellipse measured clockwise from north

start angle of ellipse segment

end angle of ellipse segment

Ellipse Arc Stripe

length of semi-major axis, outer ellipse

length of semi-minor axis, outer ellipse

length of semi-major axis, inner ellipse

length of semi-minor axis, inner ellipse

rotation of ellipse measured clockwise from north

start angle of ellipse arc stripe

end angle of ellipse arc stripe

Figure 8-1: Description of an Ellipse Arc

Structured Member Name

Structured Member Type

Longitude

TpFloat

Latitude

TpFloat

TypeOfUncertaintyShape

TpLocationUncertaintyShape

UncertaintyInnerSemiMajor

TpFloat

UncertaintyOuterSemiMajor

TpFloat

UncertaintyInnerSemiMinor

TpFloat

UncertaintyOuterSemiMinor

TpFloat

AngleOfSemiMajor

TpInt32

SegmentStartAngle

TpInt32

SegmentEndAngle

TpInt32

8.6.2.2 TpLocationUncertaintyShape

Defines the type of uncertainty shape.

Name

Value

Description

P_M_SHAPE_NONE

0

No uncertainty shape present.

P_M_SHAPE_CIRCLE

1

Uncertainty shape is a circle.

P_M_SHAPE_CIRCLE_SECTOR

2

Uncertainty shape is a circle sector.

P_M_SHAPE_CIRCLE_ARC_STRIPE

3

Uncertainty shape is a circle arc stripe.

P_M_SHAPE_ELLIPSE

4

Uncertainty shape is an ellipse.

P_M_SHAPE_ELLIPSE_SECTOR

5

Uncertainty shape is an ellipse sector.

P_M_SHAPE_ELLIPSE_ARC_STRIPE

6

Uncertainty shape is an ellipse arc stripe.

8.6.2.3 TpMobilityDiagnostic

Defines a diagnostic value that is reported in addition to an error by the Network User Location or User Status service capability feature.

Name

Value

Description

P_M_NO_INFORMATION

0

No diagnostic information present. Valid for all type of errors.

P_M_APPL_NOT_IN_PRIV_EXCEPT_LST

1

Application not in privacy exception list. Valid for ‘Unauthorised Application’ error.

P_M_CALL_TO_USER_NOT_SETUP

2

Call to user not set-up. Valid for ‘Unauthorised Application’ error.

P_M_PRIVACY_OVERRIDE_NOT_APPLIC

3

Privacy override not applicable. Valid for ‘Unauthorised Application’ error.

P_M_DISALL_BY_LOCAL_REGULAT_REQ

4

Disallowed by local regulatory requirements. Valid for ‘Unauthorised Application’ error.

P_M_CONGESTION

5

Congestion. Valid for ‘Position Method Failure’ error.

P_M_INSUFFICIENT_RESOURCES

6

Insufficient resources. Valid for ‘Position Method Failure’ error.

P_M_INSUFFICIENT_MEAS_DATA

7

Insufficient measurement data. Valid for ‘Position Method Failure’ error.

P_M_INCONSISTENT_MEAS_DATA

8

Inconsistent measurement data. Valid for ‘Position Method Failure’ error.

P_M_LOC_PROC_NOT_COMPLETED

9

Location procedure not completed. Valid for ‘Position Method Failure’ error.

P_M_LOC_PROC_NOT_SUPBY_USER

10

Location procedure not supported by user. Valid for ‘Position Method Failure’ error.

P_M_QOS_NOT_ATTAINABLE

11

Quality of service not attainable. Valid for ‘Position Method Failure’ error.

8.6.2.4 TpMobilityError

Defines an error that is reported by the Network User Location or User Status service capability feature. A fatal error occurring during the life of periodic or triggered user location/status requests (triggeredStatusReportErr, triggeredLocationReportErr or periodicLocationReportErr) will terminate the request such that any particular request is allowed to generate at most one fatal error but possibly several non fatal errors.

Name

Value

Description

Fatal

P_M_OK

0

No error occurred while processing the request.

N/A

P_M_SYSTEM_FAILURE

1

System failure.
The request can not be handled because of a general problem in the Network User Location or User Status SCF or the underlying network.

Yes

P_M_UNAUTHORIZED_NETWORK

2

Unauthorised network,
The requesting network is not authorised to obtain the user’s location or status.

No

P_M_UNAUTHORIZED_APPLICATION

3

Unauthorised application.
The application is not authorised to obtain the user’s location or status.

Yes

P_M_UNKNOWN_SUBSCRIBER

4

Unknown subscriber.
The user is unknown, i.e. no such subscription exists.

Yes

P_M_ABSENT_SUBSCRIBER

5

Absent subscriber.
The user is currently not reachable.

No

P_M_POSITION_METHOD_FAILURE

6

Position method failure.
The Network User Location SCF failed to obtain the user’s position.

No

8.6.2.5 TpMobilityStopAssignmentData

Defines the structure of data elements that specifies a request to stop whole or parts of an assignment. Assignments are used for periodic or triggered reporting of a user locations or statuses.

Observe that the parameter “users” is optional. If the parameter “stopScope” is set to P_M_ALL_IN_ASSIGNMENT, the parameter “stopScope” is undefined. If the parameter “stopScope” is set to P_M_SPECIFIED_USERS, then the assignment shall be stopped only for the users specified in the “users” collection.

Structure Element Name

Structure Element Type

Description

AssignmentId

TpSessionID

Identity of the session that shall be stopped.

StopScope

TpMobilityStopScope

Specify if only a part of the assignment or if whole the assignment shall be stopped.

Users

TpAddressSet

Optional parameter describing which users a stop request is addressing when only a part of an assignment is to be stopped.

8.6.2.6 TpMobilityStopScope

This enumeration is used in requests to stop mobility reports that are sent from the Network User Location service capability feature to an application.

Name

Value

Description

P_M_ALL_IN_ASSIGNMENT

0

The request concerns all users in an assignment.

P_M_SPECIFIED_USERS

1

The request concerns only the users that are explicitly specified in a collection.

8.6.3 Network User Location Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.mm.ul package.

8.6.3.1 TpLocationCellIDOrLAI

This data type is identical to a TString. It specifies the Cell Global Identification or the Location Area Identification (LAI).

The Cell Global Identification (CGI) is defined as the string of characters in the following format:

MCCMNCLACCI

where:

MCC Mobile Country Code (three decimal digits)

MNC Mobile Network Code (two or three decimal digits)

LAC Location area code (four hexadecimal digits)

CI Cell Identification (four hexadecimal digits)

The Location Area Identification (LAI) is defined as a string of characters in the following format:

MCCMNCLAC

where:

MCC Mobile Country Code (three decimal digits)

MNC Mobile Network Code (two or three decimal digits)

LAC Location area code (four hexadecimal digits)

The length of the parameter indicates which format is used. See 3GPP TS 29.002 for the detailed coding.

8.6.3.2 TpLocationTriggerCamel

Defines the structure of data elements that specifies the criteria for a triggered location report to be generated.

Structure Member Name

Structure Member Type

Description

UpdateInsideVlr

TpBoolean

Generate location report when it occurs an location update inside the current VLR area.

UpdateOutsideVlr

TpBoolean

Generate location report when the user moves to another VLR area.

8.6.3.3 TpUserLocationCamel

Defines the structure of data elements that specifies the location of a mobile telephony user. Observe that if the statusCode is indicating an error, then neither geographicalPosition, timestamp, vlrNumber, locationNumber, cellIdOrLai nor their associated presense flags are defined.

Structure Member Name

Structure Member Type

Description

UserID

TpAddress

The address of the user.

StatusCode

TpMobilityError

Indicator of error.

GeographicalPositionPresent

TpBoolean

Flag indicating if the geographical position is present.

GeographicalPosition

TpGeographicalPosition

Specification of a position and an area of uncertainty.

TimestampPresent

TpBoolean

Flag indicating if the timestamp is present.

Timestamp

TpDateAndTime

Timestamp indicating when the location information was attained .

VlrNumberPresent

TpBoolean

Flag indicating if the VLR number is present.

VlrNumber

TpAddress

Current VLR number for the user.

VocationNumberPresent

TpBoolean

Flag indicating if the location number is present.

LocationNumber[2]

TpAddress

Current location number.

CellIdOrLaiPresent

TpBoolean

Flag indicating if cell-id or LAI of the user is present.

CellIdOrLai

TpLocationCellIDOrLAI

Cell-id or LAI of the user.

8.6.3.4 TpUserLocationCamelSet

Defines a collection of TUserLocationCamel

8.7 User Status Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.mm.us package.

8.7.1.1 TpUserStatus

Defines the structure of data elements that specifies the identity and status of a user.

Structure Element Name

Structure Element Type

Description

UserID

TpAddress

The user address.

StatusCode

TpMobilityError

Indicator of error.

Status

TpUserStatusIndicator

The current status of the user.

8.7.1.2 TpUserStatusSet

Defines a collection of TUserStatus.

8.7.1.3 TpUserStatusIndicator

Defines the status of a user.

Name

Value

Description

P_US_REACHABLE

0

User is reachable

P_US_NOT_REACHABLE

1

User is not reachable

P_US_BUSY[3]

2

User is busy (only applicable for interactive user status request, not when triggers are used)

8.8 Terminal Capabilities Data Definitions

8.8.1 Interface Definitions

8.8.1.1 IpTerminalCapabilities

Defines the address of an IpTerminalCapabilities Interface.

8.8.1.2 IpTerminalCapabilitiesRef

Defines a reference to type IpTerminalCapabilities

8.8.2 Terminal Capabilities Data Definitions

The constants and types defined in the following sections are defined in the org.threegpp.osa.termcap package.

8.8.2.1 terminalIdentity

Identifies the terminal.

Name

Type

Documentation

terminalIdentity

TpString

Identifies the terminal. It may be a logical address known by the WAP Gateway/PushProxy.

8.8.2.2 TpTerminalCapabilities

This data type is a Sequence_of_Data_Elements that describes the terminal capabilities. It is a structured type that consists of:

Sequence Element

Name

Sequence Element

Type

Documentation

StatusCode

TpBoolean

Indicates whether or not the terminalCapabilities are available.

TerminalCapabilities

TpString

Specifies the latest available capabilities of the user´s terminal.
This information, if available, is returned as CC/PP headers as specified in W3C [6] and adopted in the WAP UAProf specification [9]. It contains URLs; terminal attributes and values, in RDF format; or a combination of both.

8.8.2.3 TpTerminalCapabilitiesError

Defines an error that is reported by the Terminal Capabilities SCF.

Name

Value

Description

P_TERMCAP_ERROR_UNDEFINED

0

Undefined.

P_TERMCAP_INVALID_TERMINALID

1

The request can not be handled because the terminal id specified is not valid.

P_TERMCAP_SYSTEM_FAILURE

2

System failure.

The request cannot be handled because of a general problem in the terminal capabilities service or the underlying network.