Interface TINAScsSubInitial::i_Subscribe

interface i_Subscribe

Interface: i_Subscribe Behavior:



Operation Index

contractService
This operation creates a (set of) new service contract(s) for an existing customer. A list of services the subscriber wants to contract is specified. It returns a list of service contract management interfaces, one for each of the services requested.
getReferences
This operation returns the subscription management interface references for a specific subscriber. If a service id list is given, only the service contract management interfaces for those services are returned. The subscriber information management interface (i_subSMSubscribe) is always returned.
listServices
This operation returns the list of services available for subscription and use.
listSubscribers
This operation returns the list of subscribers matching a search criteria (ALL to retrieve all the subscribers). It can only be used by an authorized user (retailer operator) If a service Id is specified other than the NULL one (0), only subscribers to the specified service are returned. Note: the way to express the search criteria is to be defined. SQL-like statements will be used. Parameters to use in the search are TBD.
subscribe
This operation creates a subscription for a new customer. The initial list of services the subscriber wants to contract can be specified. It returns: - a unique identifier for the subscriber. - an interface for subscriber information management. - a list of service contract management interfaces, one for each of the services initially contracted. These two last items are included in the t_InterfaceList structure.
unsubscribe
This operation withdraws a subscription or a list of service contracts. The list of services the subscriber wants to unsubscribe is an input parameter. If this list is empty, that means the withdrawal of all the services, and thus the subscription.

Exception Index

e_applicationError
e_invalidSearchCriteria
e_invalidServiceId
e_invalidSubscriberInfo
e_notSubscribedService
e_unknownServiceId
e_unknownSubscriber

Operations

contractService
void contractService(in TINASubCommonTypes::t_AccountNumber subscriberId,
                     in TINASubCommonTypes::t_ServiceIdList serviceList,
                     out TINACommonTypes::t_InterfaceList interfaceList)
    raises(e_unknownSubscriber,
           e_unknownServiceId,
           e_applicationError);

This operation creates a (set of) new service contract(s) for an existing customer. A list of services the subscriber wants to contract is specified. It returns a list of service contract management interfaces, one for each of the services requested.


getReferences
void getReferences(in TINASubCommonTypes::t_AccountNumber subscriber,
                   in TINASubCommonTypes::t_ServiceIdList serviceList,
                   out TINACommonTypes::t_InterfaceList interfaceList)
    raises(e_unknownSubscriber,
           e_notSubscribedService,
           e_applicationError);

This operation returns the subscription management interface references for a specific subscriber. If a service id list is given, only the service contract management interfaces for those services are returned. The subscriber information management interface (i_subSMSubscribe) is always returned.


listServices
void listServices(out TINAAccessCommonTypes::t_ServiceList serviceList)
    raises(e_applicationError);

This operation returns the list of services available for subscription and use.


listSubscribers
void listSubscribers(in string searchCriteria,
                     in TINAAccessCommonTypes::t_ServiceId serviceId,
                     out TINASubCommonTypes::t_SubscriberIdList subscriberList)
    raises(e_unknownServiceId,
           e_invalidSearchCriteria,
           e_applicationError);

This operation returns the list of subscribers matching a search criteria (ALL to retrieve all the subscribers). It can only be used by an authorized user (retailer operator) If a service Id is specified other than the NULL one (0), only subscribers to the specified service are returned. Note: the way to express the search criteria is to be defined. SQL-like statements will be used. Parameters to use in the search are TBD.


subscribe
void subscribe(in TINASubCommonTypes::t_Subscriber subscriberInfo,
               in TINASubCommonTypes::t_ServiceIdList serviceList,
               out TINASubCommonTypes::t_AccountNumber subscriberId,
               out TINACommonTypes::t_InterfaceList interfaceList)
    raises(e_invalidSubscriberInfo,
           e_unknownServiceId,
           e_applicationError);

This operation creates a subscription for a new customer. The initial list of services the subscriber wants to contract can be specified. It returns: - a unique identifier for the subscriber. - an interface for subscriber information management. - a list of service contract management interfaces, one for each of the services initially contracted. These two last items are included in the t_InterfaceList structure.


unsubscribe
void unsubscribe(in TINASubCommonTypes::t_AccountNumber subscriberId,
                 in TINASubCommonTypes::t_ServiceIdList serviceList)
    raises(e_unknownSubscriber,
           e_unknownServiceId,
           e_applicationError);

This operation withdraws a subscription or a list of service contracts. The list of services the subscriber wants to unsubscribe is an input parameter. If this list is empty, that means the withdrawal of all the services, and thus the subscription.



Exceptions

e_applicationError
exception e_applicationError
{
};
e_invalidSearchCriteria
exception e_invalidSearchCriteria
{
};
e_invalidServiceId
exception e_invalidServiceId
{
};
e_invalidSubscriberInfo
exception e_invalidSubscriberInfo
{
};
e_notSubscribedService
exception e_notSubscribedService
{
    TINAAccessCommonTypes::t_ServiceId serviceId;
};
e_unknownServiceId
exception e_unknownServiceId
{
    TINAAccessCommonTypes::t_ServiceId serviceId;
};
e_unknownSubscriber
exception e_unknownSubscriber
{
    TINASubCommonTypes::t_AccountNumber subscriberId;
};

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