com.sapportals.wcm.protocol.ice.protocol

Interface IICEElement

All Known Subinterfaces:

IICEExtensionRequest, IICERequestElement, IICEResponseElement

All Known Implementing Classes:

ICEAccess, ICEAccessControl, ICEAccessWindow, ICECancel, ICECancellation, ICECatalog, ICECode, ICEContact, ICEDeliveryPolicy, ICEDeliveryRule, ICEEventData, ICEEventInfo, ICEEventLog, ICEEventMsg, ICEEvents, ICEGetCatalog, ICEGetEvents, ICEGetPackage, ICEGetSequence, ICEGetStatus, ICEItem, ICEItemBase, ICEItemCollection, ICEItemGroup, ICEItemRef, ICEItemRemove, ICENop, ICEOffer, ICEPackage, ICEPackageState, ICEReceiver, ICERepairItem, ICESender, ICESequence, ICEStatus, ICESubscription, ICEText, ICEUnsolicitedNow, WCMCheckMail, WCMPullSubscription, WCMPushSubscription, WCMResolveReferences, WCMSendMail, WCMUpdateSubscriberConfig, WCMUpdateSyndicatorConfig

public interface IICEElement

This is the base "class" of all ICE elements. Every class that represents an ICE element inside an ICE payload has to implement this interface.

Copyright 2004 SAP AG

Method Summary

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.

Method Detail

write

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

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)

Access Rights

This class can be accessed from:

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