com.opencloud.slee.resources.cgin.map

Class MAPAreaEventInfo

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPAreaEventInfo

All Implemented Interfaces:

DataObject, Serializable

public class MAPAreaEventInfo
extends AbstractFieldsObject

API for MAP-LCS-DataTypes.AreaEventInfo. Generated from the following ASN.1 type definition.

 AreaEventInfo ::=
     SEQUENCE {
         areaDefinition AreaDefinition,
         occurrenceInfo OccurrenceInfo OPTIONAL,
         intervalTime   IntervalTime OPTIONAL,
         ...
     }
 

Added in release 6.

Used as field type by MAPProvideSubscriberLocation_Arg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPAreaEventInfo	clone() Constructs a copy of this object and everything reachable from it.
static MAPAreaEventInfo	copyOf(MAPAreaEventInfo 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.
MAPAreaDefinition	getAreaDefinition() Gets the value of the field areaDefinition.
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.
int	getIntervalTime() Gets the value of the field intervalTime.
MAPOccurrenceInfo	getOccurrenceInfo() Gets the value of the field occurrenceInfo.
boolean	hasAreaDefinition() Tests whether the field areaDefinition has a value.
boolean	hasIntervalTime() Tests whether the field intervalTime has a value.
boolean	hasOccurrenceInfo() Tests whether the field occurrenceInfo has a value.
MAPAreaEventInfo	setAreaDefinition(MAPAreaDefinition value) Sets the value of the field areaDefinition.
MAPAreaEventInfo	setIntervalTime(int value) Sets the value of the field intervalTime and marks the field as present.
MAPAreaEventInfo	setIntervalTimePresent(boolean flag) Sets the presence or absence of the optional field intervalTime.
MAPAreaEventInfo	setOccurrenceInfo(MAPOccurrenceInfo value) Sets the value of the field occurrenceInfo.
void	setReadOnly() Sets this and all its fields to be immutable.

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

MAPAreaEventInfo

public MAPAreaEventInfo()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPAreaEventInfo

getAreaDefinition

public MAPAreaDefinition getAreaDefinition()

Gets the value of the field areaDefinition.

Returns:

value of field areaDefinition, 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.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getIntervalTime

public int getIntervalTime()

Gets the value of the field intervalTime.

Returns:

value of field intervalTime

getOccurrenceInfo

public MAPOccurrenceInfo getOccurrenceInfo()

Gets the value of the field occurrenceInfo.

Returns:

value of field occurrenceInfo, or null if not present

hasAreaDefinition

public boolean hasAreaDefinition()

Tests whether the field areaDefinition has a value.

Returns:

whether the field areaDefinition has a value

hasIntervalTime

public boolean hasIntervalTime()

Tests whether the field intervalTime has a value.

Returns:

whether the field intervalTime has a value

hasOccurrenceInfo

public boolean hasOccurrenceInfo()

Tests whether the field occurrenceInfo has a value.

Returns:

whether the field occurrenceInfo has a value

setAreaDefinition

public MAPAreaEventInfo setAreaDefinition(MAPAreaDefinition value)
                                   throws IllegalStateException

Sets the value of the field areaDefinition.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIntervalTime

public MAPAreaEventInfo setIntervalTime(int value)
                                 throws IllegalStateException

Sets the value of the field intervalTime and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIntervalTimePresent

public MAPAreaEventInfo setIntervalTimePresent(boolean flag)
                                        throws IllegalStateException

Sets the presence or absence of the optional field intervalTime.

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

setOccurrenceInfo

public MAPAreaEventInfo setOccurrenceInfo(MAPOccurrenceInfo value)
                                   throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject