com.sapportals.wcm.service.xmlforms
Interface IXFProject

[contained in: com.sap.km.cm.service.base.par - km.shared.service.xmlforms_api.jar]

public interface IXFProject

Copyright 2004 SAP AG

Method Summary

IXFTransformation	getDefaultTransformation(java.lang.String transformationType) Gets the default transformation for a given transformation type
java.lang.String	getDisplayName(java.util.Locale clientlocale) Gets the descritive localized name of the form
java.util.Map	getDisplayTransformations() get list of show forms for the preview pane
java.lang.String	getID() Gets unique identifier of the project
java.lang.String	getProjectProperty(java.lang.String key) Gets a project property
IXFTransformation	getTransformation(java.lang.String id) Gets a transformation by its ID
boolean	isDeprecated() Checks, if the project is deprecated.
boolean	isHidden() Checks if the project is public visible or not
ISaveResult	saveItem(IPostData data, java.lang.String resName, IResourceContext resContext, java.util.Hashtable parameters) Save an item

Method Detail

getID

public java.lang.String getID()

Gets unique identifier of the project

Returns:

the project ID

getDisplayName

public java.lang.String getDisplayName(java.util.Locale clientlocale)

Gets the descritive localized name of the form

Parameters:

clientlocale - the Locale to use for localisation

Returns:

a localized project name, if it is available, otherwise a default project name. If no name is defined, the project ID is returned.

getTransformation

public IXFTransformation getTransformation(java.lang.String id)

Gets a transformation by its ID

Parameters:

id - the transformation ID (e.g. "Edit")

Returns:

an IXFTransformation object representing the requested transformation, or null, if the transformation does not exist, or an error occurred

getDefaultTransformation

public IXFTransformation getDefaultTransformation(java.lang.String transformationType)

Gets the default transformation for a given transformation type

Parameters:

transformationType - the transformation type to get the default transformation. It should be one of the constants IXFTransformation.TRANSFORMATION_TYPE_EDIT or IXFTransformation.TRANSFORMATION_TYPE_DISPLAY.

Returns:

an IXFTransformation object representing the requested transformation, or null, if the transformation does not exist, or an error occurred

isHidden

public boolean isHidden()

Checks if the project is public visible or not

Returns:

true if the project is hidden, false if it is visible

isDeprecated

public boolean isDeprecated()

Checks, if the project is deprecated. A project is considered as deprecated, if it does not have a project settings file or a post transformation, that is called <prjID>Post.xml. That is probably the case, if the project was not automatically generated with XML Forms Builder.

Returns:

true if the project is deprecated, false otherwise

getProjectProperty

public java.lang.String getProjectProperty(java.lang.String key)

Gets a project property

Parameters:

key - the property key

Returns:

the property value

getDisplayTransformations

public java.util.Map getDisplayTransformations()

get list of show forms for the preview pane

saveItem

public ISaveResult saveItem(IPostData data,
                            java.lang.String resName,
                            IResourceContext resContext,
                            java.util.Hashtable parameters)
                     throws XFException

Save an item

Parameters:

data - the data to write

resName - the full path where the item is to be saved

resContext - the context to use for saving the item

parameters - parameters to pass to the post transformation

Returns:

An instance of ISaveResult, which contains the information, whether saving was successfull and errors, which occurred

Throws:

XFException - if a problem occurs during the save process