Module TINASubCommonTypes

Module with common types definitions for subscription management.



Struct Index

t_AuthLimit
Indicates the date and time an authorization expires on and the person who granted it.
t_DateTime
Time and Date.
t_Entity
An entity is characterized by its identifier and name and a set of properties.
t_Parameter
Service Parameters definition:
t_RequiredConfiguration
This structure contains information about the minimal required configuration of a service. This is used to specify a configuration for a particular service session
t_Sae
The SAE is characterized by an identifier, a name and a set of properties
t_Sag
A SAG is characterized by its identifier, a textual description of the group and the list of entities composing it. The identifier is the same as the one for SAG Service profile corresponding to that SAG.
t_ServiceContract
Service Contract: Describes the relationship of a subscriber with the provider for the provision of a service.
t_ServiceDescription
Service Description: this type is used to describe a specific service. It is used for the description of service types, service instances and service profiles. An example of service common params could be: parameterName = ACCESS RIGHTS configurability = CONFIGURABLE_BY_SUBSCRIBER parameterValue = {join, be_invited} parameterName = REQUIRED TERMINAL TYPE configurability = FIXED_BY_PROVIDER parameterValue = {PersonalComputer, WorkStation} parameterName = REQUIRED PRESENTATION SUPPORT configurability = FIXED_BY_PROVIDER parameterValue = {WINDOWS 95, X11R6} An example of service specific params could be: parameterName = MAX NUMBER OF PARTIES IN SESSION configurability = FIXED_BY_PROVIDER parameterValue = 20 parameterName = TIME LIMIT FOR SUSPENDED SESSIONS configurability = CONFIGURABLE_BY_SUBSCRIBER parameterValue = 1 WEEK parameterName = AUTOMATIC POSITIVE ANSWER TO VOTINGS configurability = CUSTOMIZABLE_BY_USER parameterValue = YES The list of parameter names and value types that is common to all services will be defined in a separate file: TINAServiceCommonParameters.idl The list of parameter names and value types specific to particular service will be defined in a separate file: TINAServiceSpecificParameters.idl
t_ServiceProfile
t_ServiceTemplate
t_serviceTemplate: It describes a service instance.
t_Subscriber
A subscriber is identified by its account number and characterized by name, address, monthly charge, payment record, credit information, date which its subscription expires on, the list of subscribed services and the list of defined SAGs.

Union Index

t_entityId
Entity Id allows to identity uniquely an entity inside the retailer domain.

Enum Index

t_AccessRight
Service access rights.
t_NapType
NAP type: used to determine the instantation of available QoS.
t_ParameterConfigurability
Service Parameter configurability.
t_PresentationSupport
Terminal presentation technology. This is just an example
t_TermType
Terminal Type: Just an example.
t_entityType
Users, terminals and NAPs are considered (subscription) entities
t_slcmNotificationType
Notification Type, used in "i_ServiceNotify::notify"
t_subNotificationType
Notification Type, used in "i_SubscriptionNotify::notify"

Alias Index

t_AccessRightList
List of possible service access rights.
t_AccountNumber
The Account Number represents the Subscriber identifier.
t_EntityList
List of entities.
t_NAPIdList
List of NAPs
t_ParameterList
Service Parameter list:
t_ParameterName
Service Parameter name.
t_ParameterValue
Service Parameter value.
t_Person
Textual identification of a person. For example, name, address and position.
t_SagId
The SAG identifier identifies a SAG uniquely inside the retailer domain.
t_SagIdList
List of SAG Ids.
t_SagList
List of SAGs.
t_SagServiceProfile
Service Profile for a SAG.
t_SagServiceProfileList
List of SAG Service Profiles
t_ServiceIdList
List of Service Identifiers.
t_ServiceProfileId
t_ServiceProfile: It describes a service customization.
t_ServiceProfileIdList
t_ServiceProfileList
t_ServiceTemplateList
t_ServiceType
Service Types
t_SubscriberIdList
t_SubscriberList
List of Subscribers.
t_SubscriptionProfile
Service Profile by default in a Service Contract.
t_entityIdList

Structs

t_AuthLimit
struct t_AuthLimit
{
    t_DateTime limitDate;
    string authority;
};

Indicates the date and time an authorization expires on and the person who granted it.


t_DateTime
struct t_DateTime
{
    string date;
    string time;
};

Time and Date.


t_Entity
struct t_Entity
{
    t_entityId entityId;
    string entityName;
    TINACommonTypes::t_PropertyList properties;
};

An entity is characterized by its identifier and name and a set of properties.


t_Parameter
struct t_Parameter
{
    t_ParameterName name;
    t_ParameterConfigurability configurability;
    t_ParameterValue value;
};

Service Parameters definition:


t_RequiredConfiguration
struct t_RequiredConfiguration
{
    t_TermType termType;
    t_NapType nap_type;
    t_PresentationSupport presentation_support;
    TINACommonTypes::t_PropertyList others;
};

This structure contains information about the minimal required configuration of a service. This is used to specify a configuration for a particular service session


t_Sae
struct t_Sae
{
    t_entityId entityId;
    string entityName;
    TINACommonTypes::t_PropertyList properties;
};

The SAE is characterized by an identifier, a name and a set of properties


t_Sag
struct t_Sag
{
    t_SagId sagId;
    string sagDescription;
    t_entityIdList entityList;
};

A SAG is characterized by its identifier, a textual description of the group and the list of entities composing it. The identifier is the same as the one for SAG Service profile corresponding to that SAG.


t_ServiceContract
struct t_ServiceContract
{
    TINAAccessCommonTypes::t_ServiceId serviceId;
    t_AccountNumber accountNumber;
    short maxNumOfServiceProfiles;
    t_DateTime actualStart;
    t_DateTime requestedStart;
    t_Person requester;
    t_Person technicalContactPoint;
    t_AuthLimit authorityLimit;
    t_SubscriptionProfile subscriptionProfile;
    t_SagServiceProfileList sagServiceProfileList;
};

Service Contract: Describes the relationship of a subscriber with the provider for the provision of a service.


t_ServiceDescription
struct t_ServiceDescription
{
    TINAAccessCommonTypes::t_ServiceId serviceId;
    TINAAccessCommonTypes::t_UserServiceName serviceName;
    t_ParameterList serviceCommonParams;
    t_ParameterList serviceSpecificParams;
};

Service Description: this type is used to describe a specific service. It is used for the description of service types, service instances and service profiles. An example of service common params could be: parameterName = ACCESS RIGHTS configurability = CONFIGURABLE_BY_SUBSCRIBER parameterValue = {join, be_invited} parameterName = REQUIRED TERMINAL TYPE configurability = FIXED_BY_PROVIDER parameterValue = {PersonalComputer, WorkStation} parameterName = REQUIRED PRESENTATION SUPPORT configurability = FIXED_BY_PROVIDER parameterValue = {WINDOWS 95, X11R6} An example of service specific params could be: parameterName = MAX NUMBER OF PARTIES IN SESSION configurability = FIXED_BY_PROVIDER parameterValue = 20 parameterName = TIME LIMIT FOR SUSPENDED SESSIONS configurability = CONFIGURABLE_BY_SUBSCRIBER parameterValue = 1 WEEK parameterName = AUTOMATIC POSITIVE ANSWER TO VOTINGS configurability = CUSTOMIZABLE_BY_USER parameterValue = YES The list of parameter names and value types that is common to all services will be defined in a separate file: TINAServiceCommonParameters.idl The list of parameter names and value types specific to particular service will be defined in a separate file: TINAServiceSpecificParameters.idl


t_ServiceProfile
struct t_ServiceProfile
{
    t_ServiceProfileId spId;
    t_ServiceDescription serviceDescription;
};
t_ServiceTemplate
struct t_ServiceTemplate
{
    TINAAccessCommonTypes::t_ServiceId serviceInstanceId;
    TINAAccessCommonTypes::t_UserServiceName serviceInstanceName;
    t_ServiceIdList requiredServices;
    t_ServiceDescription serviceDescription;
};

t_serviceTemplate: It describes a service instance.


t_Subscriber
struct t_Subscriber
{
    t_AccountNumber accountNumber;
    TINACommonTypes::t_UserId subscriberName;
    t_Person identificationInfo;
    t_Person billingContactPoint;
    string RatePlan;
    any paymentRecord;
    any credit;
};

A subscriber is identified by its account number and characterized by name, address, monthly charge, payment record, credit information, date which its subscription expires on, the list of subscribed services and the list of defined SAGs.



Unions

t_entityId
union t_entityId switch(t_entityType)
{
case user: TINACommonTypes::t_UserId userId;
case terminal: TINAAccessCommonTypes::t_TerminalId terminalId;
case nap: TINAAccessCommonTypes::t_NAPId napId;
};

Entity Id allows to identity uniquely an entity inside the retailer domain.



Enums

t_AccessRight
enum t_AccessRight
{
    create,
    join,
    be_invited
};

Service access rights.


t_NapType
enum t_NapType
{
    UndefinedNapType,
    NapTypeFixed,
    NapTypeWireless
};

NAP type: used to determine the instantation of available QoS.


t_ParameterConfigurability
enum t_ParameterConfigurability
{
    FIXED_BY_PROVIDER,
    CONFIGURABLE_BY_SUBSCRIBER,
    CUSTOMIZABLE_BY_USER
};

Service Parameter configurability.


t_PresentationSupport
enum t_PresentationSupport
{
    UndefinedPresSupp,
    X11R6,
    WINDOWS95,
    MGEG
};

Terminal presentation technology. This is just an example


t_TermType
enum t_TermType
{
    UndefinedTermType,
    PersonalComputer,
    WorkStation,
    TVset,
    Videotelephone,
    Cellularphone,
    PBX,
    VideoServer,
    VideoBridge,
    Telephone,
    G4Fax
};

Terminal Type: Just an example.


t_entityType
enum t_entityType
{
    user,
    terminal,
    nap
};

Users, terminals and NAPs are considered (subscription) entities


t_slcmNotificationType
enum t_slcmNotificationType
{
    NEW_SERVICE,
    TEMPLATE_MODIFIED,
    SERVICE_WITHDRAWN
};

Notification Type, used in "i_ServiceNotify::notify"


t_subNotificationType
enum t_subNotificationType
{
    NEW_SERVICES,
    PROFILE_MODIFIED,
    SERVICES_WITHDRAWN
};

Notification Type, used in "i_SubscriptionNotify::notify"



Aliases

t_AccessRightList
typedef sequence<t_AccessRight> t_AccessRightList;

List of possible service access rights.


t_AccountNumber
typedef string t_AccountNumber;

The Account Number represents the Subscriber identifier.


t_EntityList
typedef sequence<t_Entity> t_EntityList;

List of entities.


t_NAPIdList
typedef sequence<TINAAccessCommonTypes::t_NAPId> t_NAPIdList;

List of NAPs


t_ParameterList
typedef sequence<t_Parameter> t_ParameterList;

Service Parameter list:


t_ParameterName
typedef string t_ParameterName;

Service Parameter name.


t_ParameterValue
typedef any t_ParameterValue;

Service Parameter value.


t_Person
typedef string t_Person;

Textual identification of a person. For example, name, address and position.


t_SagId
typedef short t_SagId;

The SAG identifier identifies a SAG uniquely inside the retailer domain.


t_SagIdList
typedef sequence<t_SagId> t_SagIdList;

List of SAG Ids.


t_SagList
typedef sequence<t_Sag> t_SagList;

List of SAGs.


t_SagServiceProfile
typedef t_ServiceProfile t_SagServiceProfile;

Service Profile for a SAG.


t_SagServiceProfileList
typedef sequence<t_SagServiceProfile> t_SagServiceProfileList;

List of SAG Service Profiles


t_ServiceIdList
typedef sequence<TINAAccessCommonTypes::t_ServiceId> t_ServiceIdList;

List of Service Identifiers.


t_ServiceProfileId
typedef string t_ServiceProfileId;

t_ServiceProfile: It describes a service customization.


t_ServiceProfileIdList
typedef sequence<t_ServiceProfileId> t_ServiceProfileIdList;
t_ServiceProfileList
typedef sequence<t_ServiceProfile> t_ServiceProfileList;
t_ServiceTemplateList
typedef sequence<t_ServiceTemplate> t_ServiceTemplateList;
t_ServiceType
typedef string t_ServiceType;

Service Types


t_SubscriberIdList
typedef sequence<t_AccountNumber> t_SubscriberIdList;
t_SubscriberList
typedef sequence<t_Subscriber> t_SubscriberList;

List of Subscribers.


t_SubscriptionProfile
typedef t_ServiceProfile t_SubscriptionProfile;

Service Profile by default in a Service Contract.


t_entityIdList
typedef sequence<t_entityId> t_entityIdList;

Generated by the OmniBroker IDL-to-HTML translator (non-commercial)