com.opencloud.slee.resources.cgin.cap_v1

Class CAP1ConnectArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCConnectArg

CAP1ConnectArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP2ConnectArg

public class CAP1ConnectArg
extends CCConnectArg

API for CAP-DataTypes.ConnectArg. Generated from the following ASN.1 type definition and the adaptations below.

 ConnectArg ::=
     SEQUENCE {
         destinationRoutingAddress DestinationRoutingAddress,
         originalCalledPartyID     OriginalCalledPartyID OPTIONAL,
         extensions                SEQUENCE (SIZE (1..10)) OF ExtensionField OPTIONAL,
         genericNumbers            GenericNumbers OPTIONAL,
         callingPartysCategory     CallingPartysCategory OPTIONAL,
         redirectingPartyID        RedirectingPartyID OPTIONAL,
         redirectionInformation    RedirectionInformation OPTIONAL,
         suppressionOfAnnouncement SuppressionOfAnnouncement OPTIONAL,
         oCSIApplicable            OCSIApplicable OPTIONAL,
         ...
     }
 CAP-DataTypes {
     ConnectArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCConnectArg
     }
 }
 

Used as argument type by CAP1Operations.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
CAP1ConnectArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CAP1ConnectArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP1ConnectArg	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.
CAP1ExtensionField[]	getExtensions() Gets the value of the field extensions.
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.
GenericNumber[]	getGenericNumbers() Gets the value of the field genericNumbers.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasGenericNumbers() Tests whether the field genericNumbers has a value.
boolean	hasOCSIApplicable() Tests whether the field oCSIApplicable is present.
boolean	hasSuppressionOfAnnouncement() Tests whether the field suppressionOfAnnouncement is present.
CAP1ConnectArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CAP1ConnectArg	setDestinationRoutingAddress(CalledPartyNumber[] value) Sets the value of the field destinationRoutingAddress.
CAP1ConnectArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP1ConnectArg	setGenericNumbers(GenericNumber[] value) Sets the value of the field genericNumbers.
CAP1ConnectArg	setOCSIApplicablePresent(boolean flag) Sets the presence or absence of the optional field oCSIApplicable.
CAP1ConnectArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
CAP1ConnectArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CAP1ConnectArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CAP1ConnectArg	setSuppressionOfAnnouncementPresent(boolean flag) Sets the presence or absence of the optional field suppressionOfAnnouncement.

Methods inherited from class CCConnectArg

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

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

CAP1ConnectArg

public CAP1ConnectArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP1ConnectArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCConnectArg

Returns:

copy of object

copyOf

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

CAP1ConnectArg

getExtensions

public CAP1ExtensionField[] getExtensions()

Gets the value of the field extensions.

Returns:

value of field extensions, 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 CCConnectArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getGenericNumbers

public GenericNumber[] getGenericNumbers()

Gets the value of the field genericNumbers.

Returns:

value of field genericNumbers, or null if not present

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasGenericNumbers

public boolean hasGenericNumbers()

Tests whether the field genericNumbers has a value.

Returns:

whether the field genericNumbers has a value

hasOCSIApplicable

public boolean hasOCSIApplicable()

Tests whether the field oCSIApplicable is present.

Returns:

whether the field oCSIApplicable is present

hasSuppressionOfAnnouncement

public boolean hasSuppressionOfAnnouncement()

Tests whether the field suppressionOfAnnouncement is present.

Returns:

whether the field suppressionOfAnnouncement is present

setCallingPartysCategory

public CAP1ConnectArg setCallingPartysCategory(CallingPartysCategory value)
                                        throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDestinationRoutingAddress

public CAP1ConnectArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                            throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Overrides:

setDestinationRoutingAddress in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP1ConnectArg setExtensions(CAP1ExtensionField[] value)
                             throws IllegalStateException

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

setGenericNumbers

public CAP1ConnectArg setGenericNumbers(GenericNumber[] value)
                                 throws IllegalStateException

Sets the value of the field genericNumbers. 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 CAP1ConnectArg setOCSIApplicablePresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field oCSIApplicable.

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

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

Overrides:

setOriginalCalledPartyID in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectingPartyID

public CAP1ConnectArg setRedirectingPartyID(RedirectingPartyNumber value)
                                     throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP1ConnectArg setRedirectionInformation(RedirectionInformation value)
                                         throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSuppressionOfAnnouncementPresent

public CAP1ConnectArg setSuppressionOfAnnouncementPresent(boolean flag)
                                                   throws IllegalStateException

Sets the presence or absence of the optional field suppressionOfAnnouncement.

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