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

Class ICERepairItem

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

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICERepairItem
extends Object
implements IICERequestElement

ICERepairItem is a reprentation of en ice-repair-item request element.

Detailed information of the ICE repair item request could be found in the ICE 1.1 specification section 5.5.3.

ice-repair-item format

 <!ELEMENT ice-repair-item       EMPTY >
 <!ATTLIST ice-repair-item
           current-state         CDATA           #REQUIRED
           subscription-element  CDATA           #REQUIRED
           subscription-id       CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICERepairItem(Attributes attributes)
Create a new ICERepairItem.

ICERepairItem(String currentState, String subscriptionElement, String subscriptionID)
Create a new ICERepairItem request.

Method Summary

String	getCurrentState() Get the identifier of the current state.
String	getSubscriptionElement() Get the persistent identifier of the damaged item.
String	getSubscriptionID() Get the identifier of the subscription.
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

ICERepairItem

public ICERepairItem(String currentState,
                     String subscriptionElement,
                     String subscriptionID)

Create a new ICERepairItem request.

Parameters:

currentState - The identifier of the current state

subscriptionElement - The persistent identifier of the damaged item

subscriptionID - The identifier of the subscription

ICERepairItem

public ICERepairItem(Attributes attributes)

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

Parameters:

attributes - The attributes of the ice-repair-item element

Method Detail

getCurrentState

public String getCurrentState()

Get the identifier of the current state.

Returns:

The identifier of the current state

getSubscriptionElement

public String getSubscriptionElement()

Get the persistent identifier of the damaged item.

Returns:

The persistent identifier of the damaged item

getSubscriptionID

public String getSubscriptionID()

Get the identifier of the subscription.

Returns:

The identifier of the subscription

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 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.

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-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