com.opencloud.slee.resources.cgin.cap_v3

Class CAP3ConnectArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCConnectArg

CAP1ConnectArg

CAP2ConnectArg

CAP3ConnectArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP4ConnectArg

public class CAP3ConnectArg
extends CAP2ConnectArg

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,
         cug-Interlock                   CUG-Interlock OPTIONAL,
         cug-OutgoingAccess              NULL OPTIONAL,
         suppressionOfAnnouncement       SuppressionOfAnnouncement OPTIONAL,
         oCSIApplicable                  OCSIApplicable OPTIONAL,
         naOliInfo                       NAOliInfo OPTIONAL,
         ...
     }
 CAP-gsmSSF-gsmSCF-ops-args {
     ConnectArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v2.CAP2ConnectArg
     }
 }
 

Used as argument type by CAP3Operations.connect.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
CAP3ConnectArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CAP3ConnectArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP3ConnectArg	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.
byte[]	getCarrier() Gets the value of the field carrier.
LocationNumber	getChargeNumber() Gets the value of the field chargeNumber.
CUGInterLockCode	getCug_Interlock() Gets the value of the field cug-Interlock.
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.
byte[]	getNaOliInfo() Gets the value of the field naOliInfo.
CAP3ServiceInteractionIndicatorsTwo	getServiceInteractionIndicatorsTwo() Gets the value of the field serviceInteractionIndicatorsTwo.
boolean	hasCarrier() Tests whether the field carrier has a value.
boolean	hasChargeNumber() Tests whether the field chargeNumber has a value.
boolean	hasCug_Interlock() Tests whether the field cug-Interlock has a value.
boolean	hasCug_OutgoingAccess() Tests whether the field cug-OutgoingAccess is present.
boolean	hasNaOliInfo() Tests whether the field naOliInfo has a value.
boolean	hasServiceInteractionIndicatorsTwo() Tests whether the field serviceInteractionIndicatorsTwo has a value.
CAP3ConnectArg	setAlertingPattern(Signal value) Sets the value of the field alertingPattern.
CAP3ConnectArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CAP3ConnectArg	setCarrier(byte[] value) Sets the value of the field carrier.
CAP3ConnectArg	setChargeNumber(LocationNumber value) Sets the value of the field chargeNumber.
CAP3ConnectArg	setCug_Interlock(CUGInterLockCode value) Sets the value of the field cug-Interlock.
CAP3ConnectArg	setCug_OutgoingAccessPresent(boolean flag) Sets the presence or absence of the optional field cug-OutgoingAccess.
CAP3ConnectArg	setDestinationRoutingAddress(CalledPartyNumber[] value) Sets the value of the field destinationRoutingAddress.
CAP3ConnectArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP3ConnectArg	setGenericNumbers(GenericNumber[] value) Sets the value of the field genericNumbers.
CAP3ConnectArg	setNaOliInfo(byte[] value) Sets the value of the field naOliInfo.
CAP3ConnectArg	setOCSIApplicablePresent(boolean flag) Sets the presence or absence of the optional field oCSIApplicable.
CAP3ConnectArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3ConnectArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CAP3ConnectArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CAP3ConnectArg	setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value) Sets the value of the field serviceInteractionIndicatorsTwo.
CAP3ConnectArg	setSuppressionOfAnnouncementPresent(boolean flag) Sets the presence or absence of the optional field suppressionOfAnnouncement.

Methods inherited from class CAP2ConnectArg

getNa_Info, hasNa_Info, setNa_Info

Methods inherited from class CAP1ConnectArg

getExtensions, getGenericNumbers, hasExtensions, hasGenericNumbers, hasOCSIApplicable, hasSuppressionOfAnnouncement

Methods inherited from class 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

CAP3ConnectArg

public CAP3ConnectArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP3ConnectArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP2ConnectArg

Returns:

copy of object

copyOf

public static CAP3ConnectArg 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:

CAP3ConnectArg

getCarrier

public byte[] getCarrier()

Gets the value of the field carrier.

Returns:

value of field carrier, or null if not present

getChargeNumber

public LocationNumber getChargeNumber()

Gets the value of the field chargeNumber.

Returns:

value of field chargeNumber, or null if not present

getCug_Interlock

public CUGInterLockCode getCug_Interlock()

Gets the value of the field cug-Interlock.

Returns:

value of field cug-Interlock, or null if not present

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 CAP2ConnectArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getNaOliInfo

public byte[] getNaOliInfo()

Gets the value of the field naOliInfo.

Returns:

value of field naOliInfo, or null if not present

getServiceInteractionIndicatorsTwo

public CAP3ServiceInteractionIndicatorsTwo getServiceInteractionIndicatorsTwo()

Gets the value of the field serviceInteractionIndicatorsTwo.

Returns:

value of field serviceInteractionIndicatorsTwo, or null if not present

hasCarrier

public boolean hasCarrier()

Tests whether the field carrier has a value.

Returns:

whether the field carrier has a value

hasChargeNumber

public boolean hasChargeNumber()

Tests whether the field chargeNumber has a value.

Returns:

whether the field chargeNumber has a value

hasCug_Interlock

public boolean hasCug_Interlock()

Tests whether the field cug-Interlock has a value.

Returns:

whether the field cug-Interlock has a value

hasCug_OutgoingAccess

public boolean hasCug_OutgoingAccess()

Tests whether the field cug-OutgoingAccess is present.

Returns:

whether the field cug-OutgoingAccess is present

hasNaOliInfo

public boolean hasNaOliInfo()

Tests whether the field naOliInfo has a value.

Returns:

whether the field naOliInfo has a value

hasServiceInteractionIndicatorsTwo

public boolean hasServiceInteractionIndicatorsTwo()

Tests whether the field serviceInteractionIndicatorsTwo has a value.

Returns:

whether the field serviceInteractionIndicatorsTwo has a value

setAlertingPattern

public CAP3ConnectArg setAlertingPattern(Signal value)
                                  throws IllegalStateException

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

Overrides:

setAlertingPattern in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CAP3ConnectArg setCallingPartysCategory(CallingPartysCategory value)
                                        throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCarrier

public CAP3ConnectArg setCarrier(byte[] value)
                          throws IllegalStateException

Sets the value of the field carrier. 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

setChargeNumber

public CAP3ConnectArg setChargeNumber(LocationNumber value)
                               throws IllegalStateException

Sets the value of the field chargeNumber. 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

setCug_Interlock

public CAP3ConnectArg setCug_Interlock(CUGInterLockCode value)
                                throws IllegalStateException

Sets the value of the field cug-Interlock. 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

setCug_OutgoingAccessPresent

public CAP3ConnectArg setCug_OutgoingAccessPresent(boolean flag)
                                            throws IllegalStateException

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

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 CAP3ConnectArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                            throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Overrides:

setDestinationRoutingAddress in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP3ConnectArg setExtensions(CAP1ExtensionField[] value)
                             throws IllegalStateException

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

Overrides:

setExtensions in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGenericNumbers

public CAP3ConnectArg setGenericNumbers(GenericNumber[] value)
                                 throws IllegalStateException

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

Overrides:

setGenericNumbers in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setNaOliInfo

public CAP3ConnectArg setNaOliInfo(byte[] value)
                            throws IllegalStateException

Sets the value of the field naOliInfo. 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

setOCSIApplicablePresent

public CAP3ConnectArg setOCSIApplicablePresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field oCSIApplicable.

Overrides:

setOCSIApplicablePresent in class CAP2ConnectArg

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 CAP3ConnectArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                        throws IllegalStateException

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

Overrides:

setOriginalCalledPartyID in class CAP2ConnectArg

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 CAP2ConnectArg

setRedirectingPartyID

public CAP3ConnectArg setRedirectingPartyID(RedirectingPartyNumber value)
                                     throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP3ConnectArg setRedirectionInformation(RedirectionInformation value)
                                         throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CAP2ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceInteractionIndicatorsTwo

public CAP3ConnectArg setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)
                                                  throws IllegalStateException

Sets the value of the field serviceInteractionIndicatorsTwo. 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

setSuppressionOfAnnouncementPresent

public CAP3ConnectArg setSuppressionOfAnnouncementPresent(boolean flag)
                                                   throws IllegalStateException

Sets the presence or absence of the optional field suppressionOfAnnouncement.

Overrides:

setSuppressionOfAnnouncementPresent in class CAP2ConnectArg

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