com.sapportals.wcm.protocol.ice.protocol

Class ICEPackageState

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.ICEPackageState

All Implemented Interfaces:

IICEElement

public class ICEPackageState
extends Object
implements IICEElement

ICEPackageState is a representation of an ice-package-state element. An ICEPackageState is part of an ICEGetSequence request or an ICESequence response.

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

 <!ELEMENT ice-package-state     EMPTY >
 <!ATTLIST ice-package-state
           package-id            CDATA           #REQUIRED
           new-state             CDATA           #REQUIRED
 >

See Also:

ICEGetSequence,

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEPackageState(Attributes attributes)
Create a new ICEPackageState.

ICEPackageState(String packageID, String newState)
Create a new ICEPackageState.

Method Summary

String	getNewState() Get the identifier of the new package state.
String	getPackageID() Get the identifier of the package.
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

ICEPackageState

public ICEPackageState(String packageID,
                       String newState)

Create a new ICEPackageState.

Parameters:

packageID - The identifier of the package

newState - The identifier of the new state

ICEPackageState

public ICEPackageState(Attributes attributes)

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

Parameters:

attributes - The attributes of the ice-package-state tag

Method Detail

getPackageID

public String getPackageID()

Get the identifier of the package.

Returns:

The identifier of the package

getNewState

public String getNewState()

Get the identifier of the new package state.

Returns:

The identifier of the new package state

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