Package com.opencloud.slee.resources.cgin.callcontrol

Provides a common API for callcontrol protocols originally based on the INAP family of protocols.

See: Description

Interface Summary

Interface	Description
CCDialog	Protocol-specific extension interface for callcontrol dialogs.

Class Summary

Class	Description
CCAChBillingChargingCharacteristics	API for CC-DataTypes.AChBillingChargingCharacteristics.
CCApplyChargingArg	API for CC-DataTypes.ApplyChargingArg.
CCApplyChargingReportArg	API for CC-DataTypes.ApplyChargingReportArg.
CCAssistRequestInstructionsArg	API for CC-DataTypes.AssistRequestInstructionsArg.
CCBasicGapCriteria	API for CC-DataTypes.BasicGapCriteria.
CCBasicGapCriteria.CalledAddressAndService	API for CC-DataTypes.BasicGapCriteria.calledAddressAndService.
CCBasicGapCriteria.CallingAddressAndService	API for CC-DataTypes.BasicGapCriteria.callingAddressAndService.
CCBasicGapCriteria.Choice	API for CC-DataTypes.BasicGapCriteria.Choice.
CCBCSMEvent	API for CC-DataTypes.BCSMEvent.
CCBearerCapability	API for CC-DataTypes.BearerCapability.
CCBearerCapability.Choice	API for CC-DataTypes.BearerCapability.Choice.
CCCallGapArg	API for CC-DataTypes.CallGapArg.
CCCallInformationReportArg	API for CC-DataTypes.CallInformationReportArg.
CCCallInformationRequestArg	API for CC-DataTypes.CallInformationRequestArg.
CCCancelArg	API for CC-DataTypes.CancelArg.
CCCancelArg.Choice	API for CC-DataTypes.CancelArg.Choice.
CCCancelFailedArg	API for CC-DataTypes.CancelFailedArg.
CCCollectedDigits	API for CC-DataTypes.CollectedDigits.
CCCollectedInfo	API for CC-DataTypes.CollectedInfo.
CCCollectedInfo.Choice	API for CC-DataTypes.CollectedInfo.Choice.
CCConnectArg	API for CC-DataTypes.ConnectArg.
CCConnectToResourceArg	API for CC-DataTypes.ConnectToResourceArg.
CCConnectToResourceArg.ResourceAddress	API for CC-DataTypes.ConnectToResourceArg.resourceAddress.
CCConnectToResourceArg.ResourceAddress.Choice	API for CC-DataTypes.ConnectToResourceArg.resourceAddress.Choice.
CCControlType	API for CC-DataTypes.ControlType.
CCEstablishTemporaryConnectionArg	API for CC-DataTypes.EstablishTemporaryConnectionArg.
CCEventReportBCSMArg	API for CC-DataTypes.EventReportBCSMArg.
CCEventSpecificInformationBCSM	API for CC-DataTypes.EventSpecificInformationBCSM.
CCEventSpecificInformationBCSM.AnalyzedInfoSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.analyzedInfoSpecificInfo.
CCEventSpecificInformationBCSM.Choice	API for CC-DataTypes.EventSpecificInformationBCSM.Choice.
CCEventSpecificInformationBCSM.CollectedInfoSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.collectedInfoSpecificInfo.
CCEventSpecificInformationBCSM.OAnswerSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.oAnswerSpecificInfo.
CCEventSpecificInformationBCSM.OCalledPartyBusySpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.oCalledPartyBusySpecificInfo.
CCEventSpecificInformationBCSM.ODisconnectSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.oDisconnectSpecificInfo.
CCEventSpecificInformationBCSM.OMidCallSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.oMidCallSpecificInfo.
CCEventSpecificInformationBCSM.ONoAnswerSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.oNoAnswerSpecificInfo.
CCEventSpecificInformationBCSM.RouteSelectFailureSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.routeSelectFailureSpecificInfo.
CCEventSpecificInformationBCSM.TAnswerSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.tAnswerSpecificInfo.
CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.tCalledPartyBusySpecificInfo.
CCEventSpecificInformationBCSM.TDisconnectSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.tDisconnectSpecificInfo.
CCEventSpecificInformationBCSM.TMidCallSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.tMidCallSpecificInfo.
CCEventSpecificInformationBCSM.TNoAnswerSpecificInfo	API for CC-DataTypes.EventSpecificInformationBCSM.tNoAnswerSpecificInfo.
CCEventTypeBCSM	API for CC-DataTypes.EventTypeBCSM.
CCFurnishChargingInformationArg	API for CC-DataTypes.FurnishChargingInformationArg.
CCFurnishChargingInformationArg.Choice	API for CC-DataTypes.FurnishChargingInformationArg.Choice.
CCFurnishChargingInformationArg.FCIBCCcs1	API for CC-DataTypes.FurnishChargingInformationArg.fCIBCCcs1.
CCGapCriteria	API for CC-DataTypes.GapCriteria.
CCGapCriteria.Choice	API for CC-DataTypes.GapCriteria.Choice.
CCGapIndicators	API for CC-DataTypes.GapIndicators.
CCGapOnService	API for CC-DataTypes.GapOnService.
CCGapTreatment	API for CC-DataTypes.GapTreatment.
CCGapTreatment.Choice	API for CC-DataTypes.GapTreatment.Choice.
CCInbandInfo	API for CC-DataTypes.InbandInfo.
CCInformationToSend	API for CC-DataTypes.InformationToSend.
CCInformationToSend.Choice	API for CC-DataTypes.InformationToSend.Choice.
CCInitialDPArg	API for CC-DataTypes.InitialDPArg.
CCIPSSPCapabilities	API for CC-DataTypes.IPSSPCapabilities.
CCLegID	API for CC-DataTypes.LegID.
CCLegID.Choice	API for CC-DataTypes.LegID.Choice.
CCMessageID	API for CC-DataTypes.MessageID.
CCMessageID.Text	API for CC-DataTypes.MessageID.text.
CCMessageID.Text.Attributes	API for CC-DataTypes.MessageID.text.attributes.
CCMessageID.VariableMessage	API for CC-DataTypes.MessageID.variableMessage.
CCMiscCallInfo	API for CC-DataTypes.MiscCallInfo.
CCMiscCallInfo.MessageType	API for CC-DataTypes.MiscCallInfo.messageType.
CCPlayAnnouncementArg	API for CC-DataTypes.PlayAnnouncementArg.
CCPromptAndCollectUserInformationArg	API for CC-DataTypes.PromptAndCollectUserInformationArg.
CCReceivedInformationArg	API for CC-DataTypes.ReceivedInformationArg.
CCReceivedInformationArg.Choice	API for CC-DataTypes.ReceivedInformationArg.Choice.
CCReleaseCallArg	API for CC-DataTypes.ReleaseCallArg.
CCReleaseCallArg.Choice	API for CC-DataTypes.ReleaseCallArg.Choice.
CCRequestedInformation	API for CC-DataTypes.RequestedInformation.
CCRequestedInformationType	API for CC-DataTypes.RequestedInformationType.
CCRequestedInformationValue	API for CC-DataTypes.RequestedInformationValue.
CCRequestedInformationValue.Choice	API for CC-DataTypes.RequestedInformationValue.Choice.
CCRequestReportBCSMEventArg	API for CC-DataTypes.RequestReportBCSMEventArg.
CCResetTimerArg	API for CC-DataTypes.ResetTimerArg.
CCScfID	API for CC-DataTypes.ScfID.
CCSCIBillingChargingCharacteristics	API for CC-DataTypes.SCIBillingChargingCharacteristics.
CCSendChargingInformationArg	API for CC-DataTypes.SendChargingInformationArg.
CCSpecializedResourceReportArg	API for CC-DataTypes.SpecializedResourceReportArg.
CCSpecializedResourceReportArg.Choice	API for CC-DataTypes.SpecializedResourceReportArg.Choice.
CCTone	API for CC-DataTypes.Tone.
CCVariablePart	API for CC-DataTypes.VariablePart.
CCVariablePart.Choice	API for CC-DataTypes.VariablePart.Choice.

Enum Summary

Enum	Description
CCCancelFailedArg.Problem	API for CC-DataTypes.CancelFailedArg.problem.
CCErrorTreatment	API for CC-DataTypes.ErrorTreatment.
CCMessageID.Choice	API for CC-DataTypes.MessageID.Choice.
CCMonitorMode	API for CC-DataTypes.MonitorMode.
CCRequestedInfoErrorArg	API for CC-DataTypes.RequestedInfoErrorArg.
CCTaskRefusedArg	API for CC-DataTypes.TaskRefusedArg.
CCTimerID	API for CC-DataTypes.TimerID.
CCUnavailableNetworkResource	API for CC-DataTypes.UnavailableNetworkResource.

Package com.opencloud.slee.resources.cgin.callcontrol Description

Provides a common API for callcontrol protocols originally based on the INAP family of protocols.

Overview

This package provides a machine-generated API derived from a "callcontrol" pseudo-protocol. This protocol provides the features common to most real callcontrol protocols originally based on INAP, such as CAP, ETSI INAP CS1, and network-specific variants of INAP.

The callcontrol pseudo-protocol is not a real protocol that can be used on a network. Instead, it is provided to act as a parent protocol for the various concrete network protocols supported by CGIN.

Services can be developed against the callcontrol API, then used against many different network protocols without needing to handle each protocol through a separate API. In cases where different behaviour is needed for different protocols, the service can drill down to the API of the actual protocol in use when needed.

API packages and identifier prefix

The callcontrol API is divided into these subpackages:

• com.opencloud.slee.resources.cgin.callcontrol - contains datatype classes and misc helper classes such as CCDialog;
• com.opencloud.slee.resources.cgin.callcontrol.metadata - contains metadata classes defining application contexts, operations, and errors;
• com.opencloud.slee.resources.cgin.callcontrol.events - contains the wrapper SLEE event classes used for notifying services of operation invokes and results;
• com.opencloud.slee.resources.cgin.callcontrol.persist - provides conversion between CGIN data objects of this protocol and Google protobuf (GPB) messages.

In general, all top-level classes and interfaces in these packages begin with a common prefix, CC, so it is safe to use a wildcard package import without colliding with other protocols.

Dialog Extension Interface

The callcontrol API defines CCDialog, an extension of the CGIN Dialog interface that adds convenience methods for dealing with callcontrol-specific operations, results, and errors. All dialog objects that are using a callcontrol-based protocol will implement this extension interface.