com.opencloud.slee.resources.cgin.map

Class MAPClipData

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPClipData

All Implemented Interfaces:

DataObject, Serializable

public class MAPClipData
extends AbstractFieldsObject

API for MAP-MS-DataTypes.ClipData. Generated from the following ASN.1 type definition.

 ClipData ::=
     SEQUENCE {
         ss-Status         Ext-SS-Status,
         overrideCategory  OverrideCategory,
         notificationToCSE NULL OPTIONAL,
         ...
     }
 

Added in release 10.

Used as field type by MAPAnyTimeSubscriptionInterrogationRes.

Used as field type by MAPAnyTimeModificationRes.

Used as field type by MAPNoteSubscriberDataModifiedArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPClipData	clone() Constructs a copy of this object and everything reachable from it.
static MAPClipData	copyOf(MAPClipData 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.
MAPOverrideCategory	getOverrideCategory() Gets the value of the field overrideCategory.
byte[]	getSs_Status() Gets the value of the field ss-Status.
boolean	hasNotificationToCSE() Tests whether the field notificationToCSE is present.
boolean	hasOverrideCategory() Tests whether the field overrideCategory has a value.
boolean	hasSs_Status() Tests whether the field ss-Status has a value.
MAPClipData	setNotificationToCSEPresent(boolean flag) Sets the presence or absence of the optional field notificationToCSE.
MAPClipData	setOverrideCategory(MAPOverrideCategory value) Sets the value of the field overrideCategory.
MAPClipData	setSs_Status(byte[] value) Sets the value of the field ss-Status.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

MAPClipData

public MAPClipData()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPClipData clone()

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

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

public static MAPClipData copyOf(MAPClipData 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:

MAPClipData

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.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getOverrideCategory

public MAPOverrideCategory getOverrideCategory()

Gets the value of the field overrideCategory.

Returns:

value of field overrideCategory, or null if not present

getSs_Status

public byte[] getSs_Status()

Gets the value of the field ss-Status.

Returns:

value of field ss-Status, or null if not present

hasNotificationToCSE

public boolean hasNotificationToCSE()

Tests whether the field notificationToCSE is present.

Returns:

whether the field notificationToCSE is present

hasOverrideCategory

public boolean hasOverrideCategory()

Tests whether the field overrideCategory has a value.

Returns:

whether the field overrideCategory has a value

hasSs_Status

public boolean hasSs_Status()

Tests whether the field ss-Status has a value.

Returns:

whether the field ss-Status has a value

setNotificationToCSEPresent

public MAPClipData setNotificationToCSEPresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field notificationToCSE.

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

setOverrideCategory

public MAPClipData setOverrideCategory(MAPOverrideCategory value)
                                throws IllegalStateException

Sets the value of the field overrideCategory.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSs_Status

public MAPClipData setSs_Status(byte[] value)
                         throws IllegalStateException

Sets the value of the field ss-Status.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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