com.opencloud.slee.resources.cgin.cap_v4

Class CAP4BCSMEvent

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCBCSMEvent

CAP2BCSMEvent

CAP4BCSMEvent

All Implemented Interfaces:

DataObject, Serializable

public class CAP4BCSMEvent
extends CAP2BCSMEvent

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

 BCSMEvent ::=
     SEQUENCE {
         eventTypeBCSM      EventTypeBCSM,
         monitorMode        MonitorMode,
         legID              LegID OPTIONAL,
         dpSpecificCriteria DpSpecificCriteria OPTIONAL,
         automaticRearm     NULL OPTIONAL,
         ...
     }
 CAP-datatypes {
     BCSMEvent {
         @parentType com.opencloud.slee.resources.cgin.cap_v2.CAP2BCSMEvent
         dpSpecificCriteria {
             @rename dPSpecificCriteria
         }
     }
 }
 

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4BCSMEvent	clone() Constructs a copy of this object and everything reachable from it.
static CAP4BCSMEvent	copyOf(CCBCSMEvent 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.
boolean	hasAutomaticRearm() Tests whether the field automaticRearm is present.
CAP4BCSMEvent	setAutomaticRearmPresent(boolean flag) Sets the presence or absence of the optional field automaticRearm.
CAP4BCSMEvent	setDPSpecificCriteria(CAP4DpSpecificCriteria value) Sets the value of the field dpSpecificCriteria.
CAP4BCSMEvent	setEventTypeBCSM(CCEventTypeBCSM value) Sets the value of the field eventTypeBCSM.
CAP4BCSMEvent	setLegID(CCLegID value) Sets the value of the field legID.
CAP4BCSMEvent	setMonitorMode(CCMonitorMode value) Sets the value of the field monitorMode.

Methods inherited from class CAP2BCSMEvent

getDPSpecificCriteria, hasDPSpecificCriteria, setDPSpecificCriteria, setReadOnly

Methods inherited from class CCBCSMEvent

getEventTypeBCSM, getLegID, getMonitorMode, hasEventTypeBCSM, hasLegID, hasMonitorMode

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

CAP4BCSMEvent

public CAP4BCSMEvent()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4BCSMEvent clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP2BCSMEvent

Returns:

copy of object

copyOf

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

CAP4BCSMEvent

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 CAP2BCSMEvent

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

hasAutomaticRearm

public boolean hasAutomaticRearm()

Tests whether the field automaticRearm is present.

Returns:

whether the field automaticRearm is present

setAutomaticRearmPresent

public CAP4BCSMEvent setAutomaticRearmPresent(boolean flag)
                                       throws IllegalStateException

Sets the presence or absence of the optional field automaticRearm.

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

setDPSpecificCriteria

public CAP4BCSMEvent setDPSpecificCriteria(CAP4DpSpecificCriteria value)
                                    throws IllegalStateException

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

setEventTypeBCSM

public CAP4BCSMEvent setEventTypeBCSM(CCEventTypeBCSM value)
                               throws IllegalStateException

Sets the value of the field eventTypeBCSM.

Overrides:

setEventTypeBCSM in class CAP2BCSMEvent

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLegID

public CAP4BCSMEvent setLegID(CCLegID value)
                       throws IllegalStateException

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

Overrides:

setLegID in class CAP2BCSMEvent

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setMonitorMode

public CAP4BCSMEvent setMonitorMode(CCMonitorMode value)
                             throws IllegalStateException

Sets the value of the field monitorMode.

Overrides:

setMonitorMode in class CAP2BCSMEvent

Parameters:

value - the new value for the field

Returns:

this

Throws:

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