public class PlanDB extends IMCMessage
Modifier and Type | Class and Description |
---|---|
static class |
PlanDB.OP |
static class |
PlanDB.TYPE |
Modifier and Type | Field and Description |
---|---|
static int |
ID_STATIC |
DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID
Constructor and Description |
---|
PlanDB() |
PlanDB(IMCDefinition defs) |
PlanDB(PlanDB.TYPE type,
PlanDB.OP op,
int request_id,
java.lang.String plan_id,
IMCMessage arg,
java.lang.String info) |
Modifier and Type | Method and Description |
---|---|
static PlanDB |
clone(IMCMessage msg) |
static PlanDB |
create(java.lang.Object... values) |
IMCMessage |
getArg() |
<T extends IMCMessage> |
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. |
void |
setArg(IMCMessage arg) |
void |
setInfo(java.lang.String info) |
void |
setOp(PlanDB.OP op) |
void |
setOp(short op) |
void |
setOp(java.lang.String op) |
void |
setPlanId(java.lang.String plan_id) |
void |
setRequestId(int request_id) |
void |
setType(PlanDB.TYPE type) |
void |
setType(short type) |
void |
setType(java.lang.String type) |
asJSON, asXml, cloneMessage, cloneMessage, compareTo, 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, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, setMessage, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate
public static final int ID_STATIC
public PlanDB()
public PlanDB(IMCDefinition defs)
public PlanDB(PlanDB.TYPE type, PlanDB.OP op, int request_id, java.lang.String plan_id, IMCMessage arg, java.lang.String info)
public static PlanDB create(java.lang.Object... values)
public static PlanDB clone(IMCMessage msg) throws java.lang.Exception
java.lang.Exception
public PlanDB.TYPE getType()
public PlanDB.OP getOp()
public int getRequestId()
public java.lang.String getPlanId()
public IMCMessage getArg()
public <T extends IMCMessage> T getArg(java.lang.Class<T> clazz) throws java.lang.Exception
java.lang.Exception
public java.lang.String getInfo()
public void setType(PlanDB.TYPE type)
type
- Type (enumerated)public void setType(java.lang.String type)
type
- Type (as a String)public void setType(short type)
type
- Type (integer value)public void setOp(PlanDB.OP op)
op
- Operation (enumerated)public void setOp(java.lang.String op)
op
- Operation (as a String)public void setOp(short op)
op
- Operation (integer value)public void setRequestId(int request_id)
request_id
- Request IDpublic void setPlanId(java.lang.String plan_id)
plan_id
- Plan IDpublic void setArg(IMCMessage arg)
arg
- Argumentpublic void setInfo(java.lang.String info)
info
- Complementary Information