public class ICEItemRef extends ICEItemBase implements IICEElementHandler, IDOMStorable
Detailed information about the ICE package structur could be found in the ICE 1.1 specification
http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section5.2" section 5.2 , the ice-item-ref
element is described in http://www.icestandard.com/spec/SPEC-ICE1.01-20000511.html#section5.2.2.3 section
5.2.2.3 .
BORDER CELLSPACING=2 CELLPADDING=0 class="dtdfrag"
ice-item-ref format
!ENTITY % attlist.item "
activation CDATA #IMPLIED
expiration CDATA #IMPLIED
content-filename CDATA #IMPLIED
content-transfer-encoding (base64 | x-native-xml)
'x-native-xml'
content-type CDATA 'application/octet-stream'
ip-status CDATA #IMPLIED
xml:lang CDATA #IMPLIED
license CDATA #IMPLIED
rights-holder CDATA #IMPLIED
show-credit CDATA #IMPLIED
subscription-element CDATA #IMPLIED
!ENTITY % cm.item-ref "(ice-access
)*"
;!ELEMENT ice-item-ref %cm.item-ref;
!ATTLIST ice-item-ref %attlist.item;
url CDATA #REQUIRED
ice-element CDATA #FIXED 'ice-item-ref'
see com.sapportals.wcm.protocol.ice.protocol.ICEPackage
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/ICEItemRef.java#1 $
Modifier and Type | Field and Description |
---|---|
static String |
CID_ITEM_REF |
static String |
TAGNAME |
Constructor and Description |
---|
ICEItemRef(Attributes attributes)
Create a new ICE item reference.
|
ICEItemRef(Element element)
Create an ICEItemRef object from a DOM-element.
|
ICEItemRef(String configId) |
ICEItemRef(String url,
String subscriptionElement,
String contentFilename,
String contentType)
Create a new ICE item reference.
|
Modifier and Type | Method and Description |
---|---|
void |
addAccess(ICEAccess access)
Add an access rule.
|
void |
deleteConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) |
boolean |
endElement(String name)
Receive notification of the end of an element.
|
List |
getAccess()
Get the list of rule to access the content of the item.
|
String |
getConfigId()
Gets the identifier of the configurable which stores the configuration of item ref.
|
String |
getContentFilename()
Get the relative filename of the ICE item.
|
String |
getContentType()
Get the mime type of the content.
|
String |
getSubscriptionElement()
Get the persistent identifier of the item in the subscription context that should be added or modified.
|
String |
getUrl()
Get the url of the item content this element refers to.
|
void |
saveConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) |
IICECharacterHandler |
startElement(String name,
Attributes attributes,
PreparsedXML input)
Receive notification of the beginning of an element.
|
Node |
store(Document document)
Store the informations into a DOM.
|
String |
toString()
Returns a string representation of this item reference.
|
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 CID_ITEM_REF
public ICEItemRef(String url, String subscriptionElement, String contentFilename, String contentType)
url
- The url of the item content this element refers tosubscriptionElement
- The id of the item in the subscription context (might be null)contentFilename
- The filename of the content (might be null)contentType
- The type of the content (mime-type)public ICEItemRef(Attributes attributes)
attributes
- The attributes of the ice-item-ref tagpublic ICEItemRef(Element element)
element
- Elementpublic ICEItemRef(String configId) throws com.sapportals.config.fwk.InitialConfigException, com.sapportals.config.fwk.CannotAccessConfigException
com.sapportals.config.fwk.InitialConfigException
com.sapportals.config.fwk.CannotAccessConfigException
public String getUrl()
public String getContentType()
public String getContentFilename()
public String getSubscriptionElement()
public List getAccess()
public void addAccess(ICEAccess access)
access
- The access rule to be addedpublic 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
- AttributesSAXException
- 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 a 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)public Node store(Document document)
store
in interface IDOMStorable
document
- The DOM document that should be used as factory for the DOM elementspublic void saveConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) throws com.sapportals.config.fwk.ConfigException
com.sapportals.config.fwk.ConfigException
public void deleteConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) throws com.sapportals.config.fwk.ConfigException
com.sapportals.config.fwk.ConfigException
public String getConfigId()
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