Package org.cip4.jdflib.extensions

Class MessageHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.MessageHelper

Direct Known Subclasses:

AuditHelper, MessageResourceHelper

public class MessageHelper
extends BaseXJDFHelper

superclass for audits and messages

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageHelper.EFamily

Field Summary

Fields inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

log, theElement

Constructor Summary

Constructors

Constructor	Description
MessageHelper(KElement mes)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	generic cleanup routine
java.lang.String	getDeviceID()	get the header of this - create if not there yet
MessageHelper.EFamily	getEFamily()
JDFMessage.EnumFamily	getFamily()	Deprecated.
KElement	getHeader()	get the header of this - create if not there yet
int	getReturnCode()
java.lang.String	getType()
boolean	isAudit()
boolean	isCommand()
static boolean	isMessage(KElement element)
boolean	isQuery()
boolean	isResponse()
boolean	isSignal()
void	setHeader(java.lang.String headerAttribute, java.lang.String value)
void	setQuery(MessageHelper hQuery)
void	setReturnCode(int rc)
JDFSubscription	subscribe(java.lang.String url)

Methods inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

appendElement, appendElement, copyHelper, deleteNode, ensureID, equals, getAttribute, getAttributeMap, getBaseHelper, getBaseHelper, getComment, getCreateElement, getDefaultVersion, getDescriptiveName, getExternalID, getGeneralID, getID, getLocalName, getRoot, getRootDoc, getVersion, getXJDFRoot, getXJMFRoot, getXPathElement, getXPathValue, getXRoot, hasAttribute, hashCode, isEqual, removeAttribute, setAttribute, setAttribute, setComment, setDefaultVersion, setID, setXPathValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageHelper

public MessageHelper(KElement mes)

Parameters:

audit -

Method Detail

cleanUp

public void cleanUp()

Description copied from class: BaseXJDFHelper

generic cleanup routine

Overrides:

cleanUp in class BaseXJDFHelper

See Also:

BaseXJDFHelper.cleanUp()

getHeader

public KElement getHeader()

get the header of this - create if not there yet

Returns:

getDeviceID

public java.lang.String getDeviceID()

get the header of this - create if not there yet

Returns:

getReturnCode

public int getReturnCode()

Returns:

setReturnCode

public void setReturnCode(int rc)

Throws:

java.lang.IllegalArgumentException

setHeader

public void setHeader(java.lang.String headerAttribute,
                      java.lang.String value)

Parameters:

headerAttribute -

value -

subscribe

public JDFSubscription subscribe(java.lang.String url)

Parameters:

url -

Returns:

null if we ain't no query, else the subscription which can be further updated

isQuery

public boolean isQuery()

Returns:

isMessage

public static boolean isMessage(KElement element)

Returns:

isCommand

public boolean isCommand()

Returns:

isResponse

public boolean isResponse()

Returns:

isAudit

public boolean isAudit()

Returns:

isSignal

public boolean isSignal()

Returns:

setQuery

public void setQuery(MessageHelper hQuery)

Parameters:

hQuery - the query or command to set the refID to

getFamily

@Deprecated
public JDFMessage.EnumFamily getFamily()

Deprecated.

Returns:

getEFamily

public MessageHelper.EFamily getEFamily()

getType

public java.lang.String getType()

Returns: