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

Class ICEGetSequence

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

All Implemented Interfaces:

IICEElementHandler, IICEElement, IICERequestElement

public class ICEGetSequence
extends Object
implements IICERequestElement, IICEElementHandler

ICEGetSequence represents an ice-get-sequence request element.

Detailed information about package sequences could be found in the ICE 1.1 specification section 5.5.2 . ice-get-sequence format

 <!ELEMENT ice-get-sequence      (ice-package-state+) >
 <!ATTLIST ice-get-sequence
           current-state         CDATA           #REQUIRED
           subscription-id       CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEGetSequence(Attributes attributes)
Create a new ICEGetSequence request.

ICEGetSequence(String currentState, String subscriptionID, Collection packageStates)
Create a new ICEGetSequence request.

Method Summary

boolean	endElement(String name) Receive notification of the end of an element.
String	getCurrentState() Get the identifier of the current state.
Collection	getPackageStates() Get the sequenece of the package states.
String	getSubscriptionID() Get the identifier of the subscription.
IICECharacterHandler	startElement(String name, Attributes attributes, PreparsedXML input) Receive notification of the beginning of an element.
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

ICEGetSequence

public ICEGetSequence(String currentState,
                      String subscriptionID,
                      Collection packageStates)

Create a new ICEGetSequence request.

Parameters:

currentState - The identifier of the current state

subscriptionID - The identifier of the subscription

packageStates - A non-empty collection of ICEPackageState elements

ICEGetSequence

public ICEGetSequence(Attributes attributes)

Create a new ICEGetSequence request. This constructor is used by ICEInput to create an ICEGetSequence from an incomming payload.

Parameters:

attributes - The attributes of the ice-get-sequence tag

Method Detail

getCurrentState

public String getCurrentState()

Get the identifier of the current state.

Returns:

The identifier of the current state

getSubscriptionID

public String getSubscriptionID()

Get the identifier of the subscription.

Returns:

The identifier of the subscription

getPackageStates

public Collection getPackageStates()

Get the sequenece of the package states.

Returns:

A collection of ICEPackageState elements

startElement

public IICECharacterHandler startElement(String name,
                                         Attributes attributes,
                                         PreparsedXML input)
                                  throws SAXException

Receive notification of the beginning of an element. ICEInput invokes this method upon a start element event from the underlying SAX parser.

Specified by:

startElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

input - The preparsed XML stream to get the element content

attributes - @todo: Description of the incoming method parameter

Returns:

An IICECharacterHandler to receive the character events from the SAX parser or null if the character events could be ignored

Throws:

SAXException - on error (might wrap another exception)

endElement

public boolean endElement(String name)
                   throws SAXException

Receive notification of the end of an element. ICEInput invokes this method upon an end element event from the underlying SAX parser.

Specified by:

endElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

Returns:

true if this handler should still receive SAX element events, false if this handler isn't interested in the following SAX element events

Throws:

SAXException - on error (might wrap another exception)

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