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

Class ICEGetPackage

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

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICEGetPackage
extends Object
implements IICERequestElement

ICEGetPackage represents an ice-get-package request element. Detailed informations about ICE get package requests could be found in the ICE 1.1 specification Section 5.3 . ice-get-package format

 <!ELEMENT ice-get-package       EMPTY >
 <!ATTLIST ice-get-package
           current-state         CDATA           #REQUIRED
           parameter             CDATA           #IMPLIED
           subscription-id       CDATA           #REQUIRED
 >

See Also:

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEGetPackage(Attributes attributes)
Construct object of class ICEGetPackage.

ICEGetPackage(String subscriptionID, String currentState)
Construct object of class ICEGetPackage.

Method Summary

String	getCurrentState() Get the CurrentState attribute of the ICEGetPackage object.
String	getParameter() Get the Parameter attribute of the ICEGetPackage object.
String	getSubscriptionID() Get the SubscriptionID attribute of the ICEGetPackage object.
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

ICEGetPackage

public ICEGetPackage(String subscriptionID,
                     String currentState)

Construct object of class ICEGetPackage.

Parameters:

subscriptionID - @todo: Description of the incoming method parameter

currentState - @todo: Description of the incoming method parameter

ICEGetPackage

public ICEGetPackage(Attributes attributes)

Construct object of class ICEGetPackage.

Parameters:

attributes - @todo: Description of the incoming method parameter

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the SubscriptionID attribute of the ICEGetPackage object.

Returns:

The SubscriptionID value

getCurrentState

public String getCurrentState()

Get the CurrentState attribute of the ICEGetPackage object.

Returns:

The CurrentState value

getParameter

public String getParameter()

Get the Parameter attribute of the ICEGetPackage object.

Returns:

The Parameter value

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 an 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-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM