oracle.syndication.ice.payload
Class Ice_code

java.lang.Object
  |
  +--oracle.xml.classgen.CGNode
        |
        +--oracle.syndication.ice.payload.Ice_code

public class Ice_code

extends oracle.xml.classgen.CGNode

implements Printable, ICEStatusCode

The Node Class representing the ice-catalog element within an ice-response element in an ICE payload The attributes allowed under this element include the following:

• numeric
• phrase
• payload-id

Since:

9.0.0.0.0 Beta

Method Summary

Type	Method
java.lang.String	getCodeDescription() Gets the description contained within the code
java.lang.String	getCodeMessageID() Get the message ID inside the Ice-code element
Ice_payload	getDocument() Get the owning document Class Ice_payload
oracle.xml.parser.v2.DTD	getDTDNode() Returns the Ice_payload DTD
int	getICEStatusCode() Gets the numeric code of the status
java.lang.String	getICEStatusPayloadId() This method is valid only when the Sender try to report a Payload-Level status code ( 3xx ); otherwise return "null"
java.lang.String	getICEStatusPhrase() Gets the phrase contained within the status
boolean	hasCodeDescription() Does the code have a description?
void	print(java.lang.String szSpace, java.io.Writer wrt) Prints the ice-code node with a specific prefix into the specified writer.

Methods inherited from class oracle.xml.classgen.CGNode

setDocument

Methods inherited from class java.lang.Object

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

Method Detail

getICEStatusCode

public int getICEStatusCode()

Gets the numeric code of the status

getCodeMessageID

public java.lang.String getCodeMessageID()

Get the message ID inside the Ice-code element

getICEStatusPhrase

public java.lang.String getICEStatusPhrase()

Gets the phrase contained within the status

getICEStatusPayloadId

public java.lang.String getICEStatusPayloadId()

This method is valid only when the Sender try to report a Payload-Level status code ( 3xx ); otherwise return "null"

hasCodeDescription

public boolean hasCodeDescription()

Does the code have a description?

getCodeDescription

public java.lang.String getCodeDescription()

Gets the description contained within the code

getDTDNode

public oracle.xml.parser.v2.DTD getDTDNode()

Returns the Ice_payload DTD

Returns:

The DTD of the Ice_payload that owns this node.

See Also:

DTD

getDocument

public Ice_payload getDocument()

Get the owning document Class Ice_payload

Returns:

The ice-payload document that owns this node.

print

public void print(java.lang.String szSpace,
                  java.io.Writer wrt)
           throws java.io.IOException

Prints the ice-code node with a specific prefix into the specified writer.

Specified by:

print in interface Printable