Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4ConnectArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCConnectArg

CAP1ConnectArg

CAP2ConnectArg

CAP3ConnectArg

CAP4ConnectArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4ConnectArg
extends CAP3ConnectArg

API for CAP-gsmSSF-gsmSCF-ops-args.ConnectArg. Generated from the following ASN.1 type definition and the adaptations below.

 ConnectArg ::=
     SEQUENCE {
         destinationRoutingAddress       DestinationRoutingAddress,
         alertingPattern                 AlertingPattern OPTIONAL,
         originalCalledPartyID           OriginalCalledPartyID OPTIONAL,
         extensions                      Extensions OPTIONAL,
         carrier                         Carrier OPTIONAL,
         callingPartysCategory           CallingPartysCategory OPTIONAL,
         redirectingPartyID              RedirectingPartyID OPTIONAL,
         redirectionInformation          RedirectionInformation OPTIONAL,
         genericNumbers                  GenericNumbers OPTIONAL,
         serviceInteractionIndicatorsTwo ServiceInteractionIndicatorsTwo OPTIONAL,
         chargeNumber                    ChargeNumber OPTIONAL,
         legToBeConnected                LegID OPTIONAL,
         cug-Interlock                   CUG-Interlock OPTIONAL,
         cug-OutgoingAccess              NULL OPTIONAL,
         suppressionOfAnnouncement       SuppressionOfAnnouncement OPTIONAL,
         oCSIApplicable                  OCSIApplicable OPTIONAL,
         naOliInfo                       NAOliInfo OPTIONAL,
         bor-InterrogationRequested      NULL OPTIONAL,
         ...
         suppress-N-CSI                  NULL OPTIONAL
     }
 CAP-gsmSSF-gsmSCF-ops-args {
     ConnectArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v3.CAP3ConnectArg
     }
 }
 

Used as argument type by CAP4Operations.connect.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CAP4ConnectArg()	Constructs an object with uninitialised state.

Method Summary

Modifier and Type	Method	Description
CAP4ConnectArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4ConnectArg	copyOf(CCConnectArg from)	Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
static FieldAccessor[]	getFieldAccessors()	Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents)	Gets a Map from field-name to field-value.
CCLegID	getLegToBeConnected()	Gets the value of the field legToBeConnected.
boolean	hasBor_InterrogationRequested()	Tests whether the field bor-InterrogationRequested is present.
boolean	hasLegToBeConnected()	Tests whether the field legToBeConnected has a value.
boolean	hasSuppress_N_CSI()	Tests whether the field suppress-N-CSI is present.
CAP4ConnectArg	setAlertingPattern(Signal value)	Sets the value of the field alertingPattern.
CAP4ConnectArg	setBor_InterrogationRequestedPresent(boolean flag)	Sets the presence or absence of the optional field bor-InterrogationRequested.
CAP4ConnectArg	setCallingPartysCategory(CallingPartysCategory value)	Sets the value of the field callingPartysCategory.
CAP4ConnectArg	setCarrier(byte[] value)	Sets the value of the field carrier.
CAP4ConnectArg	setChargeNumber(LocationNumber value)	Sets the value of the field chargeNumber.
CAP4ConnectArg	setCug_Interlock(CUGInterLockCode value)	Sets the value of the field cug-Interlock.
CAP4ConnectArg	setCug_OutgoingAccessPresent(boolean flag)	Sets the presence or absence of the optional field cug-OutgoingAccess.
CAP4ConnectArg	setDestinationRoutingAddress(CalledPartyNumber[] value)	Sets the value of the field destinationRoutingAddress.
CAP4ConnectArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP4ConnectArg	setGenericNumbers(GenericNumber[] value)	Sets the value of the field genericNumbers.
CAP4ConnectArg	setLegToBeConnected(CCLegID value)	Sets the value of the field legToBeConnected.
CAP4ConnectArg	setNaOliInfo(byte[] value)	Sets the value of the field naOliInfo.
CAP4ConnectArg	setOCSIApplicablePresent(boolean flag)	Sets the presence or absence of the optional field oCSIApplicable.
CAP4ConnectArg	setOriginalCalledPartyID(OriginalCalledNumber value)	Sets the value of the field originalCalledPartyID.
void	setReadOnly()	Sets this and all its fields to be immutable.
CAP4ConnectArg	setRedirectingPartyID(RedirectingPartyNumber value)	Sets the value of the field redirectingPartyID.
CAP4ConnectArg	setRedirectionInformation(RedirectionInformation value)	Sets the value of the field redirectionInformation.
CAP4ConnectArg	setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)	Sets the value of the field serviceInteractionIndicatorsTwo.
CAP4ConnectArg	setSuppress_N_CSIPresent(boolean flag)	Sets the presence or absence of the optional field suppress-N-CSI.
CAP4ConnectArg	setSuppressionOfAnnouncementPresent(boolean flag)	Sets the presence or absence of the optional field suppressionOfAnnouncement.

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v3.CAP3ConnectArg

getCarrier, getChargeNumber, getCug_Interlock, getNaOliInfo, getServiceInteractionIndicatorsTwo, hasCarrier, hasChargeNumber, hasCug_Interlock, hasCug_OutgoingAccess, hasNaOliInfo, hasServiceInteractionIndicatorsTwo

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v2.CAP2ConnectArg

getNa_Info, hasNa_Info, setNa_Info

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v1.CAP1ConnectArg

getExtensions, getGenericNumbers, hasExtensions, hasGenericNumbers, hasOCSIApplicable, hasSuppressionOfAnnouncement

Methods inherited from class com.opencloud.slee.resources.cgin.callcontrol.CCConnectArg

getAlertingPattern, getCallingPartysCategory, getDestinationRoutingAddress, getOriginalCalledPartyID, getRedirectingPartyID, getRedirectionInformation, hasAlertingPattern, hasCallingPartysCategory, hasDestinationRoutingAddress, hasOriginalCalledPartyID, hasRedirectingPartyID, hasRedirectionInformation

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CAP4ConnectArg

public CAP4ConnectArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4ConnectArg clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3ConnectArg

Returns:

copy of object

copyOf

public static CAP4ConnectArg copyOf(CCConnectArg from)

Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.

Parameters:

from - the object from which to copy

Returns:

CAP4ConnectArg

getFieldAccessors

public static FieldAccessor[] getFieldAccessors()

Gets a new array of the accessors for fields of this type.

Returns:

FieldAccessor[]

getFieldsMap

public Map<String,Object> getFieldsMap(boolean withAbsents)

Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.

Overrides:

getFieldsMap in class CAP3ConnectArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getLegToBeConnected

public CCLegID getLegToBeConnected()

Gets the value of the field legToBeConnected.

Returns:

value of field legToBeConnected, or null if not present

hasBor_InterrogationRequested

public boolean hasBor_InterrogationRequested()

Tests whether the field bor-InterrogationRequested is present.

Returns:

whether the field bor-InterrogationRequested is present

hasLegToBeConnected

public boolean hasLegToBeConnected()

Tests whether the field legToBeConnected has a value.

Returns:

whether the field legToBeConnected has a value

hasSuppress_N_CSI

public boolean hasSuppress_N_CSI()

Tests whether the field suppress-N-CSI is present.

Returns:

whether the field suppress-N-CSI is present

setAlertingPattern

public CAP4ConnectArg setAlertingPattern(Signal value)
                                  throws IllegalStateException

Sets the value of the field alertingPattern. If null, marks the field as absent.

Overrides:

setAlertingPattern in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setBor_InterrogationRequestedPresent

public CAP4ConnectArg setBor_InterrogationRequestedPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field bor-InterrogationRequested.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setCallingPartysCategory

public CAP4ConnectArg setCallingPartysCategory(CallingPartysCategory value)
                                        throws IllegalStateException

Sets the value of the field callingPartysCategory. If null, marks the field as absent.

Overrides:

setCallingPartysCategory in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setCarrier

public CAP4ConnectArg setCarrier(byte[] value)
                          throws IllegalStateException

Sets the value of the field carrier. If null, marks the field as absent.

Overrides:

setCarrier in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setChargeNumber

public CAP4ConnectArg setChargeNumber(LocationNumber value)
                               throws IllegalStateException

Sets the value of the field chargeNumber. If null, marks the field as absent.

Overrides:

setChargeNumber in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setCug_Interlock

public CAP4ConnectArg setCug_Interlock(CUGInterLockCode value)
                                throws IllegalStateException

Sets the value of the field cug-Interlock. If null, marks the field as absent.

Overrides:

setCug_Interlock in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setCug_OutgoingAccessPresent

public CAP4ConnectArg setCug_OutgoingAccessPresent(boolean flag)
                                            throws IllegalStateException

Sets the presence or absence of the optional field cug-OutgoingAccess.

Overrides:

setCug_OutgoingAccessPresent in class CAP3ConnectArg

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setDestinationRoutingAddress

public CAP4ConnectArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                            throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Overrides:

setDestinationRoutingAddress in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setExtensions

public CAP4ConnectArg setExtensions(CAP1ExtensionField[] value)
                             throws IllegalStateException

Sets the value of the field extensions. If null, marks the field as absent.

Overrides:

setExtensions in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setGenericNumbers

public CAP4ConnectArg setGenericNumbers(GenericNumber[] value)
                                 throws IllegalStateException

Sets the value of the field genericNumbers. If null, marks the field as absent.

Overrides:

setGenericNumbers in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLegToBeConnected

public CAP4ConnectArg setLegToBeConnected(CCLegID value)
                                   throws IllegalStateException

Sets the value of the field legToBeConnected. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setNaOliInfo

public CAP4ConnectArg setNaOliInfo(byte[] value)
                            throws IllegalStateException

Sets the value of the field naOliInfo. If null, marks the field as absent.

Overrides:

setNaOliInfo in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setOCSIApplicablePresent

public CAP4ConnectArg setOCSIApplicablePresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field oCSIApplicable.

Overrides:

setOCSIApplicablePresent in class CAP3ConnectArg

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setOriginalCalledPartyID

public CAP4ConnectArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                        throws IllegalStateException

Sets the value of the field originalCalledPartyID. If null, marks the field as absent.

Overrides:

setOriginalCalledPartyID in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class CAP3ConnectArg

setRedirectingPartyID

public CAP4ConnectArg setRedirectingPartyID(RedirectingPartyNumber value)
                                     throws IllegalStateException

Sets the value of the field redirectingPartyID. If null, marks the field as absent.

Overrides:

setRedirectingPartyID in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setRedirectionInformation

public CAP4ConnectArg setRedirectionInformation(RedirectionInformation value)
                                         throws IllegalStateException

Sets the value of the field redirectionInformation. If null, marks the field as absent.

Overrides:

setRedirectionInformation in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setServiceInteractionIndicatorsTwo

public CAP4ConnectArg setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)
                                                  throws IllegalStateException

Sets the value of the field serviceInteractionIndicatorsTwo. If null, marks the field as absent.

Overrides:

setServiceInteractionIndicatorsTwo in class CAP3ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setSuppress_N_CSIPresent

public CAP4ConnectArg setSuppress_N_CSIPresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field suppress-N-CSI.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setSuppressionOfAnnouncementPresent

public CAP4ConnectArg setSuppressionOfAnnouncementPresent(boolean flag)
                                                   throws IllegalStateException

Sets the presence or absence of the optional field suppressionOfAnnouncement.

Overrides:

setSuppressionOfAnnouncementPresent in class CAP3ConnectArg

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only