com.sapportals.wcm.protocol.ice.protocol.handler

Interface IICEItemHandler

public interface IICEItemHandler

An IICEItemHandler receives ICEItem events inside an ICE package. An ICE item handler has to be registered at the corresponding ICEPackage. The processing of the ICE items is hander-based since the number an size of the items inside an ICE package could be quite big.

Copyright 2004 SAP AG

See Also:

ICEPackage

Method Summary

void	endItemGroup(ICEItemGroup group) Receive notification of the end of an ICE item group.
void	handleItem(ICEItem item) Receive notification of an ICE item element.
void	handleItemRef(ICEItemRef itemRef) Receive notification of an ICE item reference element.
void	handleItemRemove(ICEItemRemove itemRemove) Receive notification of an ICE remove item element.
void	startItemGroup(ICEItemGroup group) Receive notification of the beginning of an ICE item group.

Method Detail

handleItem

void handleItem(ICEItem item)
                throws Exception

Receive notification of an ICE item element. ICEInput resp. ICEPackage invokes this method once it encounters an ice-item element inside an ice-package. The item content could be accessed by the getContentStream() method which uses a stream of the XML preparser.

Parameters:

item - The ICEItem inside the ICEPackage

Throws:

Exception

See Also:

PreparsedXML

handleItemRef

void handleItemRef(ICEItemRef itemRef)
                   throws Exception

Receive notification of an ICE item reference element. ICEInput resp. ICEPackage invokes this method once it encounters an ice-item-ref element inside an ice-package. The content of the item should be access according to the access rules in the ICEItemRef object.

Parameters:

itemRef - The ICEItemRef inside the ICEPackage

Throws:

Exception

handleItemRemove

void handleItemRemove(ICEItemRemove itemRemove)
                      throws Exception

Receive notification of an ICE remove item element. ICEInput resp. ICEPackage invokes this method once it encounters an ice-item-remove element inside an ice-package.

Parameters:

itemRemove - The ICEItemRemove inside the ICEPackage

Throws:

Exception

startItemGroup

void startItemGroup(ICEItemGroup group)
                    throws Exception

Receive notification of the beginning of an ICE item group. ICEInput resp. ICEPackage invokes this method at the beginning of an ice-item-group element inside an ice-package.

Parameters:

group - The ICEItemGroup inside the ICEPackage

Throws:

Exception

endItemGroup

void endItemGroup(ICEItemGroup group)

Receive notification of the end of an ICE item group. ICEInput resp. ICEPackage invokes this method at the end of an ice-item-group element inside an ice-package.

Parameters:

group - The ICEItemGroup inside the ICEPackage

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