com.sapportals.wcm.protocol.ice.protocol.response

Class ICECancellation

java.lang.Object

com.sapportals.wcm.protocol.ice.protocol.response.ICECancellation

All Implemented Interfaces:

IICEElement, IICEResponseElement

public class ICECancellation
extends Object
implements IICEResponseElement

ICECancellation is a representation of an ice-cancellation response. Detailed informations about the ICE cancellation response could be found in the ICE 1.1 specification http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section4.6.1 Section 4.6.1 BORDER CELLSPACING=2 CELLPADDING=0 class="dtdfrag" ice-cancellation format <!ELEMENT ice-cancellation EMPTY > <!ATTLIST ice-cancellation cancellation-id CDATA #REQUIRED subscription-id CDATA #REQUIRED > Copyright 2004 SAP AG

See Also:

ICECancel

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAGNAME

Constructor Summary

Constructors

Constructor and Description
ICECancellation(Attributes attributes) Construct object of class ICECancellation.
ICECancellation(String cancellationID, String subscriptionID) Construct object of class ICECancellation.

Method Summary

Modifier and Type	Method and Description
String	getSubscriptionID() Get the SubscriptionID attribute of the ICECancellation object.
void	write(ContentHandler handler) Write the XML representation of the ICE element to a SAX ContentHandler.
boolean	writeChunk(ContentHandler handler) Write a chunk of XML to a SAX ContentHandler.

Methods inherited from class java.lang.Object

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

Field Detail

TAGNAME

public static final String TAGNAME

See Also:

Constant Field Values

Constructor Detail

ICECancellation

public ICECancellation(String cancellationID,
                       String subscriptionID)

Construct object of class ICECancellation.

Parameters:

cancellationID - todo: Description of the incoming method parameter

subscriptionID - todo: Description of the incoming method parameter

ICECancellation

public ICECancellation(Attributes attributes)

Construct object of class ICECancellation.

Parameters:

attributes - todo: Description of the incoming method parameter

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the SubscriptionID attribute of the ICECancellation object.

Returns:

The SubscriptionID value

write

public void write(ContentHandler handler)
           throws SAXException

Write the XML representation of the ICE element to a SAX ContentHandler. This method is used by ICEOutput to create an ICE payload.

Specified by:

write in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually an XMLSerializer)

Throws:

SAXException - on error (might wrap another exception)

writeChunk

public boolean writeChunk(ContentHandler handler)
                   throws SAXException

Write a chunk of XML to a SAX ContentHandler. This method is used by ICEOutput to write an ICE payload in chunked mode.

Specified by:

writeChunk in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually a XMLSerializer)

Returns:

true if there are more chunks in the queue

Throws:

SAXException - on error (might wrap another exception)