public class EPPMsgQueue extends java.lang.Object implements EPPCodecComponent
EPPMsgQueue
describes messages queued for client retrieval. A
<msgQ> element MUST NOT be present if there are no messages queued
for client retrieval. A <msgQ> element MAY be present in responses
to EPP commands other than the <pol> command if messages are queued
for retrieval. A <msgQ> element MUST be present in responses to the
EPP <poll> command if messages are queued for retrieval. The
<msgQ> element contains the following attributes: Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_LANG
The default language of the reason "en".
|
Constructor and Description |
---|
EPPMsgQueue()
Default constructor required for serialization.
|
EPPMsgQueue(java.lang.Long aCount,
java.lang.String aId)
Allocates a new
EPPMsgQueue with the required attributes. |
EPPMsgQueue(java.lang.Long aCount,
java.lang.String aId,
java.util.Date aQDate,
org.w3c.dom.NodeList aMsgNodeList)
Allocates a new
EPPMsgQueue with all of the attributes. |
EPPMsgQueue(java.lang.Long aCount,
java.lang.String aId,
java.util.Date aQDate,
java.lang.String aMsg)
Allocates a new
EPPMsgQueue with all of the attributes. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPMsgQueue . |
void |
decode(org.w3c.dom.Element aElement)
decode
EPPMsgQueue from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode
EPPMsgQueue into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPMsgQueue compare. |
java.lang.Long |
getCount()
Gets the number of messages that exist in the queue.
|
java.lang.String |
getId()
Gets the id that uniquely identifies the message at the head of the
queue.
|
java.lang.String |
getLang()
Gets the message language.
|
java.lang.String |
getMsg()
Gets the optional human-readable message.
|
org.w3c.dom.NodeList |
getMsgNodeList()
Gets the message DOM
NodeList representing
mixed XML content for the message. |
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.util.Date |
getQDate()
Gets the optional date and time that the message was enqueued.
|
void |
setCount(java.lang.Long aCount)
Sets the number of messages that exist in the queue.
|
void |
setId(java.lang.String aId)
Gets the id that uniquely identifies the message at the head of the
queue.
|
void |
setLang(java.lang.String aLang)
Sets the message language.
|
void |
setMsg(java.lang.String aMsg)
Sets the optional human-readable message.
|
void |
setMsgNodeList(org.w3c.dom.NodeList aMsgNodeList)
Sets the message DOM
NodeList representing
mixed XML content for the message. |
void |
setQDate(java.util.Date aDate)
Sets the optional date and time that the message was enqueued.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String DEFAULT_LANG
public EPPMsgQueue()
count
and id
attributes must be set before calling
encode
.public EPPMsgQueue(java.lang.Long aCount, java.lang.String aId)
EPPMsgQueue
with the required attributes.
The optional attributes are initialized to null
.aCount
- The number of messages that exist in the queueaId
- uniquely identify the message at the head of the queuepublic EPPMsgQueue(java.lang.Long aCount, java.lang.String aId, java.util.Date aQDate, java.lang.String aMsg)
EPPMsgQueue
with all of the attributes.aCount
- The number of messages that exist in the queueaId
- uniquely identify the message at the head of the queueaQDate
- date and time that the message was enqueuedaMsg
- human-readable message. The language defaults to
DEFAULT_LANG
, but can be set with
setLang(String)
.public EPPMsgQueue(java.lang.Long aCount, java.lang.String aId, java.util.Date aQDate, org.w3c.dom.NodeList aMsgNodeList)
EPPMsgQueue
with all of the attributes.aCount
- The number of messages that exist in the queueaId
- uniquely identify the message at the head of the queueaQDate
- date and time that the message was enqueuedaMsgNodeList
- Mixed XML content for the message.public java.lang.Long getCount()
public void setCount(java.lang.Long aCount)
aCount
- Number of messages in the queuepublic java.lang.String getId()
public void setId(java.lang.String aId)
aId
- Message idpublic java.util.Date getQDate()
null
otherwise.public void setQDate(java.util.Date aDate)
aDate
- The date and time that the message was enqueuedpublic java.lang.String getLang()
DEFAULT_LANG
.public void setLang(java.lang.String aLang)
aLang
- Language of the message.public java.lang.String getMsg()
DEFAULT_LANG
, but the value can be retrieved with the
getLang()
method.null
otherwise.public void setMsg(java.lang.String aMsg)
DEFAULT_LANG
, but can be set with the
setLang(String)
method.aMsg
- human-readable messagepublic org.w3c.dom.NodeList getMsgNodeList()
NodeList
representing
mixed XML content for the message. This is an alternative
to using a simple String
for the message.NodeList
if defined;null
otherwisepublic void setMsgNodeList(org.w3c.dom.NodeList aMsgNodeList)
NodeList
representing
mixed XML content for the message. This is an alternative
to using a simple String
for the message.aMsgNodeList
- NodeList
containing mixed XML contentpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPMsgQueue
into a DOM element tree.encode
in interface EPPCodecComponent
aDocument
- Factory for DOM componentsEPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPMsgQueue
from a DOM element tree. The
aElement
argument needs to be the "extValue" element.decode
in interface EPPCodecComponent
aElement
- The "extValue" XML element.EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPMsgQueue
compare.equals
in class java.lang.Object
aObject
- EPPMsgQueue
instance to compare withtrue
if equal; false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPMsgQueue
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPMsgQueue
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.