public class ICEPackage extends ICEItemCollection implements IICERequestElement, IICEResponseElement, IICEElementHandler
ice-item-group
|
ice-item
|
ice-item-ref
" >
<!ENTITY % cm.package "((ice-item-remove
+, (%cm.content;)*) |
(%cm.content;)+)" >
<!ELEMENT ice-package (%cm.package;) >
<!ATTLIST ice-package
activation CDATA #IMPLIED
atomic-use (false | true) "false"
confirmation (false | true) "false"
editable (false | true) "false"
exclusion CDATA #IMPLIED
expiration CDATA #IMPLIED
fullupdate (false | true) "false"
xml:lang CDATA #IMPLIED
new-state CDATA #REQUIRED
old-state CDATA #REQUIRED
package-id CDATA #REQUIRED
show-credit CDATA #IMPLIED
subscription-id CDATA #REQUIRED
ip-status CDATA #IMPLIED
license CDATA #IMPLIED
item-repair (false | true) "false"
rights-holder CDATA #IMPLIED
>
see com.sapportals.wcm.protocol.ice.protocol.request.ICEGetPackage Copyright 2004 SAP AG author Bodo Junglas - junglas@objectcode.de version $Id: //kmgmt/km.shared.protocol/NW750EXT_13_COR/src/_ice/java/api/com/sapportals/wcm/protocol/ice/protocol/ICEPackage.java#1 $
Modifier and Type | Field and Description |
---|---|
static String |
STATE_INITIAL |
static String |
TAGNAME |
m_itemIterator
Constructor and Description |
---|
ICEPackage(Attributes attributes)
Create a new ICEPackage.
|
ICEPackage(String packageID,
String subscriptionID,
String oldState,
String newState,
IICEItemIterator itemIterator)
Create a new ICEPackage.
|
Modifier and Type | Method and Description |
---|---|
boolean |
endElement(String name)
Receive notification of the end of an element.
|
String |
getNewState()
Get the if of the state after this package has been processed.
|
String |
getOldState()
Get the id of the state this package depends on.
|
String |
getPackageID()
Get the id of the package.
|
String |
getSubscriptionID()
Get the id of the subscription.
|
boolean |
isAtomicUse()
Check if the ICE package is considered as a single entity.
|
boolean |
isEditable()
Check if the content of the ICE package is editable.
|
boolean |
isFullupdate()
Check if the ICE package contains a full update.
|
boolean |
isItemRepair()
Check if the the ICE package item repair flag is set.
|
void |
setFullupdate(boolean fullupdate)
Set the ICE package to full update.
|
void |
setItemHandler(IICEItemHandler itemHandler)
Register an IICEItemHandler that should receive notifications about the ICE items inside the package.
|
void |
setItemRepair(boolean itemRepair)
Set the ICE package item repair flag.
|
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.
|
public static final String TAGNAME
public static final String STATE_INITIAL
public ICEPackage(Attributes attributes) throws SAXException
attributes
- The attributes of the ice-package tagSAXException
- Exception raised in failure situationSAXException
- if the ice-package tag is invalidpublic ICEPackage(String packageID, String subscriptionID, String oldState, String newState, IICEItemIterator itemIterator)
packageID
- The id of the packagesubscriptionID
- The id of the subscriptionoldState
- The id of the state this package depends onnewState
- The id of the state after this package has been processeditemIterator
- todo: Description of the incoming method parameterpublic void setFullupdate(boolean fullupdate)
fullupdate
- true if the package contains a full updateisFullupdate()
public void setItemRepair(boolean itemRepair)
itemRepair
- true if the package contains an individual asset pairisItemRepair()
public void setItemHandler(IICEItemHandler itemHandler)
itemHandler
- The IICEItemHandler that should receive the notificationspublic String getPackageID()
public String getSubscriptionID()
public String getOldState()
public String getNewState()
public boolean isFullupdate()
public boolean isItemRepair()
Detailed informationscould be found in the ICE 1.1 specification http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section5.5.3 section 5.5.3 .
public boolean isAtomicUse()
public boolean isEditable()
public IICECharacterHandler startElement(String name, Attributes attributes, PreparsedXML input) throws SAXException
startElement
in interface IICEElementHandler
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 contentattributes
- todo: Description of the incoming method parameterSAXException
- on error (might wrap another exception)public boolean endElement(String name) throws SAXException
endElement
in interface IICEElementHandler
name
- The local name of the XML element (we don't need namespaces at this point)SAXException
- on error (might wrap another exception)public void write(ContentHandler handler) throws SAXException
write
in interface IICEElement
handler
- The SAX ContentHandler (usually an XMLSerializer)SAXException
- on error (might wrap another exception)public boolean writeChunk(ContentHandler handler) throws SAXException
writeChunk
in interface IICEElement
handler
- The SAX ContentHandler (usually a XMLSerializer)SAXException
- on error (might wrap another exception)Access Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice