pt.lsts.imc

Class PlanDB

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanDB

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class PlanDB
extends IMCMessage

IMC Message Plan DB (556)
Request/reply to plan database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanDB.OP
static class	PlanDB.TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
PlanDB()
PlanDB(IMCDefinition defs)
PlanDB(IMCMessage msg)
PlanDB(PlanDB.TYPE type, PlanDB.OP op, int request_id, java.lang.String plan_id, IMCMessage arg, java.lang.String info)

Method Summary

Modifier and Type	Method and Description
static PlanDB	clone(IMCMessage msg)
static PlanDB	create(java.lang.Object... values)
IMCMessage	getArg()
<T extends IMCMessage> T	getArg(java.lang.Class<T> clazz)
java.lang.String	getInfo()
PlanDB.OP	getOp() Indicates the operation affecting the DB. The operation may relate to a single plan or the entire plan DB. For each request, a plan DB may reply with any number of 'in progress' replies followed by a success or a failure reply. The 'op', 'request_id' and 'plan_id' fields of a request will be echoed in one or more responses to that request. The operation at stake also determines a certain type of the 'arg' field, and whether or not the 'plan_id' field needs to be set.
java.lang.String	getPlanId()
int	getRequestId()
PlanDB.TYPE	getType() Indicates if the message is a request, or a reply to a previous request.
PlanDB	setArg(IMCMessage arg)
PlanDB	setInfo(java.lang.String info)
PlanDB	setOp(PlanDB.OP op)
PlanDB	setOp(short op)
PlanDB	setOp(java.lang.String op)
PlanDB	setPlanId(java.lang.String plan_id)
PlanDB	setRequestId(int request_id)
PlanDB	setType(PlanDB.TYPE type)
PlanDB	setType(short type)
PlanDB	setType(java.lang.String type)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PlanDB

public PlanDB()

PlanDB

public PlanDB(IMCMessage msg)

PlanDB

public PlanDB(IMCDefinition defs)

PlanDB

public PlanDB(PlanDB.TYPE type,
              PlanDB.OP op,
              int request_id,
              java.lang.String plan_id,
              IMCMessage arg,
              java.lang.String info)

Method Detail

create

public static PlanDB create(java.lang.Object... values)

clone

public static PlanDB clone(IMCMessage msg)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getType

public PlanDB.TYPE getType()

Indicates if the message is a request, or a reply to a
previous request.

Returns:

Type (enumerated) - uint8_t

getOp

public PlanDB.OP getOp()

Indicates the operation affecting the DB.
The operation may relate to a single plan or the entire plan DB.
For each request, a plan DB may reply with any number of 'in progress'
replies followed by a success or a failure reply.
The 'op', 'request_id' and 'plan_id' fields of a request will be echoed
in one or more responses to that request.
The operation at stake also determines a certain type of the 'arg' field,
and whether or not the 'plan_id' field needs to be set.

Returns:

Operation (enumerated) - uint8_t

getRequestId

public int getRequestId()

Returns:

Request ID - uint16_t

getPlanId

public java.lang.String getPlanId()

Returns:

Plan ID - plaintext

getArg

public IMCMessage getArg()

Returns:

Argument - message

getArg

public <T extends IMCMessage> T getArg(java.lang.Class<T> clazz)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getInfo

public java.lang.String getInfo()

Returns:

Complementary Information - plaintext

setType

public PlanDB setType(PlanDB.TYPE type)

Parameters:

type - Type (enumerated)

setType

public PlanDB setType(java.lang.String type)

Parameters:

type - Type (as a String)

setType

public PlanDB setType(short type)

Parameters:

type - Type (integer value)

setOp

public PlanDB setOp(PlanDB.OP op)

Parameters:

op - Operation (enumerated)

setOp

public PlanDB setOp(java.lang.String op)

Parameters:

op - Operation (as a String)

setOp

public PlanDB setOp(short op)

Parameters:

op - Operation (integer value)

setRequestId

public PlanDB setRequestId(int request_id)

Parameters:

request_id - Request ID

setPlanId

public PlanDB setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan ID

setArg

public PlanDB setArg(IMCMessage arg)

Parameters:

arg - Argument

setInfo

public PlanDB setInfo(java.lang.String info)

Parameters:

info - Complementary Information