Modifier and Type | Method and Description |
---|---|
IXFProject |
getDefaultXFProject()
Gets an
IXFProject , which represents the default transformations,
e.g. as a fallback for rendering |
IXFProject |
getXFProject(String id)
Gets the xml transformation project by ID
|
IXFProject |
getXFProject(String id,
String homeDir)
Get a new
IXFProject instance with a custom home directory |
IXFProject |
getXFProjectForRersource(IResource item)
Gets the projct for this item type
|
String |
getXFProjectIDForResource(IResource item)
Gets project id from resource type
|
Map |
getXFProjects()
Gets all projects from the XML Forms framework.
|
Map |
getXFProjects(ICollection collection)
Gets all projects from the XML Forms framework, which are allowed in a specific collection.
|
Map |
getXFProjects(String collection)
Gets all projects from the XML Forms framework, which are allowed in a specific collection.
|
RID |
getXMLFormsRoot()
Gets the RID of the XML Forms root collection
|
void |
invalidateProjects()
Discards all XML Forms projects, they are reloaded as needed
|
void |
invalidateProjects(String projectId)
Discards a given XML Forms project, it is reloaded as needed.
|
getDescription, getDescription, getID
RID getXMLFormsRoot()
null
,
if it is not availableIXFProject getXFProject(String id)
id
- the ID of the project to be returnedIXFProject
object for the given ID or null if it does not existIXFProject getXFProject(String id, String homeDir)
IXFProject
instance with a custom home directoryid
- the project IDhomeDir
- the project home directory. If it is a relative path (does not start with a slash), the
path is relative to <XML Forms Home>/<Project ID>IXFProject
instance, or null
if the requested project is not available or contains errorsIXFProject getDefaultXFProject()
IXFProject
, which represents the default transformations,
e.g. as a fallback for renderingIXFProject getXFProjectForRersource(IResource item)
item
- the item to get the project forIXFProject
object for the given item or null if it is not an XML Forms itemString getXFProjectIDForResource(IResource item)
item
- the item to get the project ID forMap getXFProjects()
IXFProject.isHidden()
and
IXFProject.isDeprecated()
methods to select the visible projects.Map getXFProjects(ICollection collection) throws XFException
IXFProject.isHidden()
andIXFProject.isDeprecated()
methods to select
the visible projects.collection
- collection to check, which XML Forms projects are availablenull
XFException
Map getXFProjects(String collection)
IXFProject.isHidden()
and IXFProject.isDeprecated()
methods to select
the visible projects.collection
- , RID of the collection to check, which XML Forms projects are availablevoid invalidateProjects() throws XFException
XFException
void invalidateProjects(String projectId) throws XFException
projectId
- the ID of the project, which was changed, deleted or createdXFException
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