public interface IXFTransformation
Copyright 2004 SAP AG
Modifier and Type | Field and Description |
---|---|
static String |
TRANSFORMATION_TYPE_DISPLAY
Constant for retrieving the default display transformation with the
IXFProject.getDefaultTransformation() method |
static String |
TRANSFORMATION_TYPE_EDIT
Constant for retrieving the default edit transformation with the
IXFProject.getDefaultTransformation() method |
static String |
TRANSFORMATION_TYPE_ITEMLIST
Constant for retrieving the default item list transformation with the
IXFProject.getDefaultTransformation() method |
Modifier and Type | Method and Description |
---|---|
boolean |
generatesFragment()
Checks if this transformation generates a HTML fragment
|
String |
getDisplayConfiguration()
Configuration that should be used render an item with this resource in a new browser window
|
String |
getDisplayName(Locale clientlocale)
Gets a localized descritive name of the transformation
|
String |
getEncoding()
Gets the character encoding of the generated output
|
String |
getID()
Gets the projectwide unique identifier of the transformation
|
Date |
getLastModified()
Gets the modification time of the transformation
|
String |
getMimeType()
Gets the mime type of the generated output
|
String |
getTransformationProperty(String key)
Gets a transformation property
|
InputStream |
render(IResource item,
Hashtable parameters)
Apply transformation on an XML item to generate HTML
|
InputStream |
render(ISaveResult result,
IResourceContext context,
Hashtable parameters)
Apply transformation on result, if the
saveItem() method of IXFProject
failed to validate or post the data. |
InputStream |
render(String resid,
IResourceContext context,
Hashtable parameters)
Apply transformation on an XML item to generate HTML
|
InputStream |
renderItemOrTemplate(String resid,
String dstPath,
IResourceContext context,
Hashtable parameters)
Apply transformation on an XML item.
|
InputStream |
renderTemplate(String dstPath,
IResourceContext context,
Hashtable parameters)
Apply transformation on XML template item to generate HTML
|
InputStream |
renderWithPreview(IResource previewItem,
String dstPath,
Hashtable parameters)
Apply transformation on a temporary (author preview) XML item to generate HTML
|
InputStream |
renderWithPreview(String previewItem,
IResourceContext context,
String dstPath,
Hashtable parameters)
Apply transformation on a temporary (author preview) XML item to generate HTML
|
static final String TRANSFORMATION_TYPE_EDIT
IXFProject.getDefaultTransformation()
methodstatic final String TRANSFORMATION_TYPE_DISPLAY
IXFProject.getDefaultTransformation()
methodstatic final String TRANSFORMATION_TYPE_ITEMLIST
IXFProject.getDefaultTransformation()
methodString getID()
String getDisplayName(Locale clientlocale)
clientlocale
- the Locale to use for localisationnull
is returned.String getDisplayConfiguration()
window.open()
call as third parameterboolean generatesFragment()
true
if this transformation generates a HTML fragment only,
false
if it generates a whole pageInputStream render(IResource item, Hashtable parameters) throws XFException
item
- the XML item to transformparameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- if an error occurred during the render processInputStream render(String resid, IResourceContext context, Hashtable parameters) throws XFException
resid
- the ID of the XML item to transformcontext
- the context to useparameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- if an error occurred during the render processInputStream render(ISaveResult result, IResourceContext context, Hashtable parameters) throws XFException
saveItem()
method of IXFProject
failed to validate or post the data. The result contains additional error information, which
can be used to highlight incorrect data.result
- the ISaveResult
instance, which was returned by saveItem()
context
- the context to useparameters
- external parameters for the transformationInputStream
containing HTML data, or null
if result
was the
result of a successfull operationXFException
- if an error occurred during the render processInputStream renderTemplate(String dstPath, IResourceContext context, Hashtable parameters) throws XFException
dstPath
- the path where a new item will be createdcontext
- the context of the user, who wants to create a new item. It is necessary
for default values. That context is not used to read the template XML.parameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- if an error occurred during the transformation processInputStream renderItemOrTemplate(String resid, String dstPath, IResourceContext context, Hashtable parameters) throws XFException
renderTemplate()
.resid
- the ID of the XML item to renderdstPath
- if the item specified with resid
does not exist, a new item will
be created in the path specified by dstPath
context
- the context to useparameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- XFException if an error occurred during the transformation processInputStream renderWithPreview(IResource previewItem, String dstPath, Hashtable parameters) throws XFException
previewItem
- the temporary item containing XML datadstPath
- full path of the item to create, if save button is pressedparameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- if an error occurred during the transformation processInputStream renderWithPreview(String previewItem, IResourceContext context, String dstPath, Hashtable parameters) throws XFException
previewItem
- the RID of the temporary item containing XML datacontext
- the context to usedstPath
- full path of the item to create, if save button is pressedparameters
- external parameters for the transformationInputStream
containing HTML dataXFException
- if an error occurred during the transformation processString getTransformationProperty(String key)
key
- the property keyString getMimeType()
String getEncoding()
Date getLastModified()
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