com.sapportals.wcm.protocol.ice.protocol

Class ICEItemRemove

java.lang.Object

com.sapportals.wcm.protocol.ice.protocol.ICEItemBase

com.sapportals.wcm.protocol.ice.protocol.ICEItemRemove

All Implemented Interfaces:

IICEElement

public class ICEItemRemove
extends ICEItemBase

ICEItemRemove represents an ice-item-remove element inside an ice-package. An ice-item-remove is sended whenever content has to be removed from the subscriber. Detailed information about the ICE package structur could be found in the ICE 1.1 specification http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section5.2 section 5.2 , the ice-item-remove element is described in href="http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section5.2.3" section 5.2.3 . BORDER CELLSPACING=2 CELLPADDING=0 class="dtdfrag" ice-item-remove format <!ELEMENT ice-item-remove EMPTY > <!ATTLIST ice-item-remove subscription-element CDATA #REQUIRED ice-element CDATA #FIXED 'ice-item-remove' name CDATA #IMPLIED > Copyright 2004 SAP AG author Bodo Junglas - junglas@objectcode.de version $Id: //kmgmt/km.shared.protocol/NW750EXT_22_COR/src/_ice/java/api/com/sapportals/wcm/protocol/ice/protocol/ICEItemRemove.java#1 $

Constructor Summary

Constructors

Constructor and Description
ICEItemRemove(Attributes attributes) Create a new ICE remove item.
ICEItemRemove(String subscriptionElement) Create a new ICE remove item.

Method Summary

Modifier and Type	Method and Description
String	getSubscriptionElement() Get the id of the element in the subscription context that should be removed.
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

Constructor Detail

ICEItemRemove

public ICEItemRemove(String subscriptionElement)

Create a new ICE remove item.

Parameters:

subscriptionElement - The id (in the subscription) of the item to be removed.

ICEItemRemove

public ICEItemRemove(Attributes attributes)

Create a new ICE remove item. This constructor is used by ICEInput to decode an ICE remove item from an ICE payload

Parameters:

attributes - The attributes of the ice-item-remove tag

Method Detail

getSubscriptionElement

public String getSubscriptionElement()

Get the id of the element in the subscription context that should be removed.

Returns:

The id of the element in the subscription context.

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.

Parameters:

handler - The SAX ContentHandler (usually a 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.

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)