Package com.opencloud.slee.resources.cgin.cap_v2

Class CAP2ConnectArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCConnectArg

CAP1ConnectArg

CAP2ConnectArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP3ConnectArg

public class CAP2ConnectArg
extends CAP1ConnectArg

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

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

Used as argument type by CAP2Operations.connect.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CAP2ConnectArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP2ConnectArg	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.
CAP2NA_Info	getNa_Info()	Gets the value of the field na-Info.
boolean	hasNa_Info()	Tests whether the field na-Info has a value.
CAP2ConnectArg	setAlertingPattern(Signal value)	Sets the value of the field alertingPattern.
CAP2ConnectArg	setCallingPartysCategory(CallingPartysCategory value)	Sets the value of the field callingPartysCategory.
CAP2ConnectArg	setDestinationRoutingAddress(CalledPartyNumber[] value)	Sets the value of the field destinationRoutingAddress.
CAP2ConnectArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP2ConnectArg	setGenericNumbers(GenericNumber[] value)	Sets the value of the field genericNumbers.
CAP2ConnectArg	setNa_Info(CAP2NA_Info value)	Sets the value of the field na-Info.
CAP2ConnectArg	setOCSIApplicablePresent(boolean flag)	Sets the presence or absence of the optional field oCSIApplicable.
CAP2ConnectArg	setOriginalCalledPartyID(OriginalCalledNumber value)	Sets the value of the field originalCalledPartyID.
void	setReadOnly()	Sets this and all its fields to be immutable.
CAP2ConnectArg	setRedirectingPartyID(RedirectingPartyNumber value)	Sets the value of the field redirectingPartyID.
CAP2ConnectArg	setRedirectionInformation(RedirectionInformation value)	Sets the value of the field redirectionInformation.
CAP2ConnectArg	setSuppressionOfAnnouncementPresent(boolean flag)	Sets the presence or absence of the optional field suppressionOfAnnouncement.

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

CAP2ConnectArg

public CAP2ConnectArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP2ConnectArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP1ConnectArg

Returns:

copy of object

copyOf

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

CAP2ConnectArg

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 CAP1ConnectArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getNa_Info

public CAP2NA_Info getNa_Info()

Gets the value of the field na-Info.

Returns:

value of field na-Info, or null if not present

hasNa_Info

public boolean hasNa_Info()

Tests whether the field na-Info has a value.

Returns:

whether the field na-Info has a value

setAlertingPattern

public CAP2ConnectArg setAlertingPattern(Signal value)
                                  throws IllegalStateException

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

Overrides:

setAlertingPattern in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CAP2ConnectArg setCallingPartysCategory(CallingPartysCategory value)
                                        throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDestinationRoutingAddress

public CAP2ConnectArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                            throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Overrides:

setDestinationRoutingAddress in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP2ConnectArg setExtensions(CAP1ExtensionField[] value)
                             throws IllegalStateException

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

Overrides:

setExtensions in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGenericNumbers

public CAP2ConnectArg setGenericNumbers(GenericNumber[] value)
                                 throws IllegalStateException

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

Overrides:

setGenericNumbers in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setNa_Info

public CAP2ConnectArg setNa_Info(CAP2NA_Info value)
                          throws IllegalStateException

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

Sets the presence or absence of the optional field oCSIApplicable.

Overrides:

setOCSIApplicablePresent in class CAP1ConnectArg

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

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

Overrides:

setOriginalCalledPartyID in class CAP1ConnectArg

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 CCConnectArg

setRedirectingPartyID

public CAP2ConnectArg setRedirectingPartyID(RedirectingPartyNumber value)
                                     throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP2ConnectArg setRedirectionInformation(RedirectionInformation value)
                                         throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CAP1ConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSuppressionOfAnnouncementPresent

public CAP2ConnectArg setSuppressionOfAnnouncementPresent(boolean flag)
                                                   throws IllegalStateException

Sets the presence or absence of the optional field suppressionOfAnnouncement.

Overrides:

setSuppressionOfAnnouncementPresent in class CAP1ConnectArg

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