com.sapportals.wcm.protocol.ice.protocol.request

Class ICECancel

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.request.ICECancel

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICECancel
extends Object
implements IICERequestElement

ICECancel represents an ice-cancel request. Detailed informations about the ICE cancel request could be found in the ICE 1.1 specification ice-cancel format

 <!ELEMENT ice-cancel            EMPTY >
 <!ATTLIST ice-cancel
           xml:lang              CDATA           #REQUIRED
           reason                CDATA           #REQUIRED
           subscription-id       CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

See Also:

ICECancellation

Field Summary

static String

TAGNAME

Constructor Summary

ICECancel(Attributes attributes)
Create a new ICECancel request.

ICECancel(String subscriptionID, String reason, String language)
Create a new ICECancel request.

Method Summary

String	getSubscriptionID() Get the identifier of the subscription that should be canceled.
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

ICECancel

public ICECancel(String subscriptionID,
                 String reason,
                 String language)

Create a new ICECancel request.

Parameters:

subscriptionID - The id of the subscription

reason - The reason of the cancellation

language - The language identifier of the reason

ICECancel

public ICECancel(Attributes attributes)

Create a new ICECancel request. This constructor is used by ICEInput to decode an ICE get catalog request from an ICE payload.

Parameters:

attributes - The attributes of the ice-cancel element

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the identifier of the subscription that should be canceled.

Returns:

The identifier of the subscription that should be canceled.

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)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM