com.sapportals.wcm.service.xmlforms

Interface IXFService

All Superinterfaces:

IService

public interface IXFService

extends IService

Copyright 2004 SAP AG

Method Summary

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.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Method Detail

getXMLFormsRoot

public RID getXMLFormsRoot()

Gets the RID of the XML Forms root collection

Returns:

the RID of the XML Forms root collection, or null, if it is not available

getXFProject

public IXFProject getXFProject(String id)

Gets the xml transformation project by ID

Parameters:

id - the ID of the project to be returned

Returns:

the IXFProject object for the given ID or null if it does not exist

getXFProject

public IXFProject getXFProject(String id,
                               String homeDir)

Get a new IXFProject instance with a custom home directory

Parameters:

id - the project ID

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

Returns:

a new IXFProject instance, or null if the requested project is not available or contains errors

getDefaultXFProject

public IXFProject getDefaultXFProject()

Gets an IXFProject, which represents the default transformations, e.g. as a fallback for rendering

Returns:

the default project

getXFProjectForRersource

public IXFProject getXFProjectForRersource(IResource item)

Gets the projct for this item type

Parameters:

item - the item to get the project for

Returns:

the IXFProject object for the given item or null if it is not an XML Forms item

getXFProjectIDForResource

public String getXFProjectIDForResource(IResource item)

Gets project id from resource type

Parameters:

item - the item to get the project ID for

Returns:

the ID of the concerned xml project or null if not applicable

getXFProjects

public Map getXFProjects()

Gets all projects from the XML Forms framework. The caller should use the IXFProject.isHidden() and IXFProject.isDeprecated() methods to select the visible projects.

Returns:

a read only map with project IDs as keys. The values are Strings representing the project home directories.

getXFProjects

public Map getXFProjects(ICollection collection)
                  throws XFException

Gets all projects from the XML Forms framework, which are allowed in a specific collection. The caller should use the IXFProject.isHidden() andIXFProject.isDeprecated() methods to select the visible projects.

Parameters:

collection - collection to check, which XML Forms projects are available

Returns:

read only map with project IDs as keys. The values are Strings representing the project home directories. In error case, it returns null

Throws:

XFException

getXFProjects

public Map getXFProjects(String collection)

Gets all projects from the XML Forms framework, which are allowed in a specific collection. The caller should use the IXFProject.isHidden() and IXFProject.isDeprecated() methods to select the visible projects.

Returns:

read only map with project IDs as keys. The values are Strings representing the project home directories.

invalidateProjects

public void invalidateProjects()
                        throws XFException

Discards all XML Forms projects, they are reloaded as needed

Throws:

XFException

invalidateProjects

public void invalidateProjects(String projectId)
                        throws XFException

Discards a given XML Forms project, it is reloaded as needed. It should be called every time, a project changed.

Parameters:

projectId - the ID of the project, which was changed, deleted or created

Throws:

XFException