org.dmd.dmp.shared.generated.dmo

Class DMPMessageDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dmp.shared.generated.dmo.DMPMessageDMO

All Implemented Interfaces:

de.novanic.eventservice.client.event.Event, Serializable

Direct Known Subclasses:

DMPEventDMO, RequestDMO, ResponseDMO

public abstract class DMPMessageDMO
extends DmcObject
implements de.novanic.eventservice.client.event.Event, Serializable

The DMPMessage class provides a common base for all messages that\n comprise the Dark Matter Protocol (DMP).

Generated from the dmp schema at version 0.1

This code was auto-generated by the dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	constructionClassName

Fields inherited from class org.dmd.dmc.DmcObject

__objectClass, attributes

Constructor Summary

Constructors

Modifier	Constructor and Description
	DMPMessageDMO()
protected	DMPMessageDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addNvp(NameValuePair value) Adds another nvp to the specified value.
DmcAttribute<?>	addNvp(Object value) Adds another nvp value.
DmcAttribute<?>	addRequestID(Integer value) Adds another requestID to the specified value.
DmcAttribute<?>	addRequestID(Object value) Adds another requestID value.
DmcAttribute<?>	delNvp(NameValuePair value) Deletes a nvp from the specified value.
DmcAttribute<?>	delNvp(Object value) Deletes a nvp value.
DmcAttribute<?>	delRequestID(Integer value) Deletes a requestID from the specified value.
DmcAttribute<?>	delRequestID(Object value) Deletes a requestID value.
NameValuePair	getNthNvp(int i)
Integer	getNthRequestID(int i)
Iterator<NameValuePair>	getNvp()
int	getNvpSize()
Iterator<Integer>	getRequestID()
int	getRequestIDSize()
Long	getTimeMS()
Boolean	isTrackingEnabled()
boolean	nvpContains(NameValuePair value)
void	remNvp() Removes the nvp attribute value.
void	remRequestID() Removes the requestID attribute value.
void	remTimeMS() Removes the timeMS attribute value.
void	remTrackingEnabled() Removes the trackingEnabled attribute value.
boolean	requestIDContains(Integer value)
void	setTimeMS(Long value) Sets timeMS to the specified value.
void	setTimeMS(Object value) Sets timeMS to the specified value.
void	setTrackingEnabled(Boolean value) Sets trackingEnabled to the specified value.
void	setTrackingEnabled(Object value) Sets trackingEnabled to the specified value.
boolean	supportsBackrefTracking() If a class of object doesn't support back reference tracking, it will overload this method to return false.

Methods inherited from class org.dmd.dmc.DmcObject

add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, equals, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getDataType, getFullClassName, getLastValue, getModifier, getNew, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getSlice, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

constructionClassName

public static final String constructionClassName

See Also:

Constant Field Values

Constructor Detail

DMPMessageDMO

public DMPMessageDMO()

DMPMessageDMO

protected DMPMessageDMO(String oc)

Method Detail

supportsBackrefTracking

public boolean supportsBackrefTracking()

Description copied from class: DmcObject

If a class of object doesn't support back reference tracking, it will overload this method to return false. Otherwise, back reference tracking can be turned on for all objects. This distinction is important for things like Dark Matter Protocol messages where we would want to ensure that object references could be resolved, but we wouldn't want to update back references in those objects to which the messages referred.

Overrides:

supportsBackrefTracking in class DmcObject

Returns:

true if the object supports backref tracking.

getTimeMS

public Long getTimeMS()

setTimeMS

public void setTimeMS(Long value)

Sets timeMS to the specified value.

Parameters:

value - Long

setTimeMS

public void setTimeMS(Object value)
               throws DmcValueException

Sets timeMS to the specified value.

Parameters:

value - A value compatible with DmcTypeLongSV

Throws:

DmcValueException - if value is not correct

remTimeMS

public void remTimeMS()

Removes the timeMS attribute value.

isTrackingEnabled

public Boolean isTrackingEnabled()

setTrackingEnabled

public void setTrackingEnabled(Boolean value)

Sets trackingEnabled to the specified value.

Parameters:

value - Boolean

setTrackingEnabled

public void setTrackingEnabled(Object value)
                        throws DmcValueException

Sets trackingEnabled to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if value is not correct

remTrackingEnabled

public void remTrackingEnabled()

Removes the trackingEnabled attribute value.

getNvp

public Iterator<NameValuePair> getNvp()

Returns:

An Iterator of NameValuePair objects.

getNthNvp

public NameValuePair getNthNvp(int i)

Parameters:

i - the index

Returns:

The nth NameValuePair value.

addNvp

public DmcAttribute<?> addNvp(NameValuePair value)

Adds another nvp to the specified value.

Parameters:

value - NameValuePair

Returns:

the attribute instance

nvpContains

public boolean nvpContains(NameValuePair value)

Parameters:

value - NameValuePair

Returns:

true if we contain a valued keyed by the specified NameValuePair.

addNvp

public DmcAttribute<?> addNvp(Object value)
                       throws DmcValueException

Adds another nvp value.

Parameters:

value - A value compatible with NameValuePair

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getNvpSize

public int getNvpSize()

Returns:

the number of values in nvp

delNvp

public DmcAttribute<?> delNvp(Object value)
                       throws DmcValueException

Deletes a nvp value.

Parameters:

value - The NameValuePair to be deleted from set of attribute values.

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delNvp

public DmcAttribute<?> delNvp(NameValuePair value)

Deletes a nvp from the specified value.

Parameters:

value - NameValuePair

Returns:

the deleted attribute instance

remNvp

public void remNvp()

Removes the nvp attribute value.

getRequestID

public Iterator<Integer> getRequestID()

Returns:

An Iterator of Integer objects.

getNthRequestID

public Integer getNthRequestID(int i)

Parameters:

i - the index

Returns:

The nth Integer value.

addRequestID

public DmcAttribute<?> addRequestID(Integer value)

Adds another requestID to the specified value.

Parameters:

value - Integer

Returns:

the attribute instance

requestIDContains

public boolean requestIDContains(Integer value)

Parameters:

value - Integer

Returns:

true if we contain a valued keyed by the specified Integer.

addRequestID

public DmcAttribute<?> addRequestID(Object value)
                             throws DmcValueException

Adds another requestID value.

Parameters:

value - A value compatible with Integer

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getRequestIDSize

public int getRequestIDSize()

Returns:

the number of values in requestID

delRequestID

public DmcAttribute<?> delRequestID(Object value)
                             throws DmcValueException

Deletes a requestID value.

Parameters:

value - The Integer to be deleted from set of attribute values.

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delRequestID

public DmcAttribute<?> delRequestID(Integer value)

Deletes a requestID from the specified value.

Parameters:

value - Integer

Returns:

the deleted attribute instance

remRequestID

public void remRequestID()

Removes the requestID attribute value.