com.sapportals.wcm.service.xmlforms
Interface IXMLFormsService

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

All Superinterfaces:

IService

Deprecated. use IXFService, IXFProject and IXFTransformation instead

public interface IXMLFormsService

extends IService

Copyright 2004 SAP AG

Field Summary

static java.lang.String	GLOBAL_CONFIG_PRO_ALLOW_HTML Deprecated.
static java.lang.String	GLOBAL_CONFIG_PRO_FORMS_PATH Deprecated.
static java.lang.String	GLOBAL_CONFIG_PRO_XFBUILDER_HELP Deprecated.
static java.lang.String	GLOBAL_CONFIG_PRO_XMLFORMS_HOME Deprecated.

Method Summary

boolean	checkGlobalResourceFile(java.lang.String name) Deprecated. Check if a global resource file exists for a given language.
java.lang.String	getDefaultDisplayWindowOpenParameters(java.lang.String prjId) Deprecated. Get parameters for JavaScript window.open call for the default display form
java.lang.String	getDefaultEditWindowOpenParameters(java.lang.String prjId) Deprecated. Get parameters for JavaScript window.open call for the default edit form
java.io.InputStream	getFormCreat(java.lang.String FormType, IResourceContext context) Deprecated. Get a form to create a new resource of the appropriate type
java.io.InputStream	getFormDisplay(java.lang.String FormType, IResource resource) Deprecated. Get an display forms from the xmlforms framework
java.lang.String	getFormDisplayName(java.lang.String prjId, java.lang.String form, java.util.Locale locale) Deprecated. Finds the localized display name of a form.
java.io.InputStream	getFormEdit(java.lang.String FormType, IResource resource) Deprecated. Get an edit forms from the xmlforms framework
java.lang.String	getFormTypeFromResource(IResource res) Deprecated. Get from id from resource type
java.util.HashMap	getFormTypes() Deprecated. Get all defined form IDs from the xmlforms framework
java.util.HashMap	getFormTypes(IResource collection) Deprecated. Get defined form IDs from the xmlforms framework
java.lang.String	getGlobalConfigProperty(java.lang.String paramKey) Deprecated. Gets a global parameter of the xml forms framework or xfbuilder from the cm configuration
java.lang.String	getProjectDisplayName(java.lang.String prjId, java.util.Locale locale) Deprecated. Finds the localized display name of a project.
java.lang.String	getWindowOpenParameters(java.lang.String prjId, java.lang.String form) Deprecated. Get parameters for JavaScript window.open call
IXMLFormManager	getXMLFormManager() Deprecated. Get the native xml forms framework form manager
java.util.Date	getXSLLastModified(java.lang.String ProjectID, java.lang.String XSLName) Deprecated. return modification date of a transformation of a given project
void	invalidateResourceBundles(java.lang.String prjId) Deprecated. Invalidate the ResourceBundle cache for a project, i.e. all entries in the cache for that project with any Locale will be deleted.
boolean	isApplicable(IResource res) Deprecated. check if applicabel on resource
boolean	isHTMLFragment(java.lang.String prjId, java.lang.String form, java.lang.String tmpDir) Deprecated. Returns, whether a form is only a HTML fragment or a full HTML page
boolean	isXSLModified(java.lang.String ProjectID, java.lang.String XSLName) Deprecated. check if a transformation of a given project has been modified
void	reloadAllFormTypes() Deprecated. reload all defined form IDs from the xmlforms framework this can be used by the XL Forms Builder or a repository to update the IDs collection when new porjects have been created, or old projects have been deleted if a project name is supplied, reload is only done if the project is not already known
void	reloadAllFormTypes(java.lang.String NewProject) Deprecated.

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

getDescription, getDescription, getID

Field Detail

GLOBAL_CONFIG_PRO_XMLFORMS_HOME

public static final java.lang.String GLOBAL_CONFIG_PRO_XMLFORMS_HOME

Deprecated.

GLOBAL_CONFIG_PRO_XFBUILDER_HELP

public static final java.lang.String GLOBAL_CONFIG_PRO_XFBUILDER_HELP

Deprecated.

GLOBAL_CONFIG_PRO_FORMS_PATH

public static final java.lang.String GLOBAL_CONFIG_PRO_FORMS_PATH

Deprecated.

GLOBAL_CONFIG_PRO_ALLOW_HTML

public static final java.lang.String GLOBAL_CONFIG_PRO_ALLOW_HTML

Deprecated.

Method Detail

getXMLFormManager

public IXMLFormManager getXMLFormManager()
                                  throws java.lang.Exception

Deprecated.

Get the native xml forms framework form manager

Returns:

xml forms manager

getFormTypeFromResource

public java.lang.String getFormTypeFromResource(IResource res)
                                         throws WcmException

Deprecated.

Get from id from resource type

Returns:

collection of strings of the form ids

getFormTypes

public java.util.HashMap getFormTypes()
                               throws WcmException

Deprecated.

Get all defined form IDs from the xmlforms framework

Returns:

collection of strings of the form ids

getFormTypes

public java.util.HashMap getFormTypes(IResource collection)
                               throws WcmException

Deprecated.

Get defined form IDs from the xmlforms framework

Parameters:

collectionurl, - if defined the types allowed for this folder are returned

Returns:

collection of strings of the form ids

reloadAllFormTypes

public void reloadAllFormTypes()
                        throws WcmException

Deprecated.

reload all defined form IDs from the xmlforms framework this can be used by the XL Forms Builder or a repository to update the IDs collection when new porjects have been created, or old projects have been deleted if a project name is supplied, reload is only done if the project is not already known

reloadAllFormTypes

public void reloadAllFormTypes(java.lang.String NewProject)
                        throws WcmException

Deprecated.

isApplicable

public boolean isApplicable(IResource res)
                     throws WcmException

Deprecated.

check if applicabel on resource

Parameters:

res - resource to check

Returns:

true if aplicable

getFormCreat

public java.io.InputStream getFormCreat(java.lang.String FormType,
                                        IResourceContext context)
                                 throws java.lang.Exception

Deprecated.

Get a form to create a new resource of the appropriate type

Parameters:

FormType - id of the form to be generated

rescontext - collection resource context

Returns:

input stream of the rendered form

getFormDisplay

public java.io.InputStream getFormDisplay(java.lang.String FormType,
                                          IResource resource)
                                   throws java.lang.Exception

Deprecated.

Get an display forms from the xmlforms framework

Parameters:

FormType - id of the form to be generated

resourceurl - url of the resource to be displayed

Returns:

collection of strings of the form ids

getFormEdit

public java.io.InputStream getFormEdit(java.lang.String FormType,
                                       IResource resource)
                                throws java.lang.Exception

Deprecated.

Get an edit forms from the xmlforms framework

Parameters:

FormType - id of the form to be generated

resourceurl - url of the resource to be displayed

Returns:

collection of strings of the form ids

getWindowOpenParameters

public java.lang.String getWindowOpenParameters(java.lang.String prjId,
                                                java.lang.String form)

Deprecated.

Get parameters for JavaScript window.open call

Parameters:

prjId - the project id

form - the form name

Returns:

the JavaScript parameters as a comma-separated list of key value pairs

getDefaultEditWindowOpenParameters

public java.lang.String getDefaultEditWindowOpenParameters(java.lang.String prjId)

Deprecated.

Get parameters for JavaScript window.open call for the default edit form

Parameters:

prjId - the project id

Returns:

the JavaScript parameters as a comma-separated list of key value pairs

getDefaultDisplayWindowOpenParameters

public java.lang.String getDefaultDisplayWindowOpenParameters(java.lang.String prjId)

Deprecated.

Get parameters for JavaScript window.open call for the default display form

Parameters:

prjId - the project id

Returns:

the JavaScript parameters as a comma-separated list of key value pairs

isHTMLFragment

public boolean isHTMLFragment(java.lang.String prjId,
                              java.lang.String form,
                              java.lang.String tmpDir)

Deprecated.

Returns, whether a form is only a HTML fragment or a full HTML page

Parameters:

prjId - the project id

form - the form name

Returns:

true, if the form is a full HTML page, false otherwise

getProjectDisplayName

public java.lang.String getProjectDisplayName(java.lang.String prjId,
                                              java.util.Locale locale)

Deprecated.

Finds the localized display name of a project.

Parameters:

prjId - the ID of the project, for which the display name is requested

locale - the Locale to use

Returns:

the localized display name from the ResourceBundle of the project, or null, if the ResourceBundle cannot be loaded, or it contains no display name.

getFormDisplayName

public java.lang.String getFormDisplayName(java.lang.String prjId,
                                           java.lang.String form,
                                           java.util.Locale locale)

Deprecated.

Finds the localized display name of a form.

Parameters:

prjId - the ID of the project, for which the display name is requested

form - the form, for which the display name is requested (e.g. RenderListItem.xsl)

locale - the Locale to use

Returns:

the localized display name from the ResourceBundle of the project, or null, if the ResourceBundle cannot be loaded, or it contains no display name for the form.

invalidateResourceBundles

public void invalidateResourceBundles(java.lang.String prjId)

Deprecated.

Invalidate the ResourceBundle cache for a project, i.e. all entries in the cache for that project with any Locale will be deleted.

Parameters:

prjId - the ID of the project, for which ResourceBundles have changed. If prjId is null, the complete cache will be invalidated.

getGlobalConfigProperty

public java.lang.String getGlobalConfigProperty(java.lang.String paramKey)

Deprecated.

Gets a global parameter of the xml forms framework or xfbuilder from the cm configuration

Parameters:

paramKey - Key of the parameter to retive

Returns:

value of the required paramater.

isXSLModified

public boolean isXSLModified(java.lang.String ProjectID,
                             java.lang.String XSLName)

Deprecated.

check if a transformation of a given project has been modified

Parameters:

ProjectID - xml forms project id e.g. "SAP_DemoNews"

XSLName - xml forms xsl name e.g. "SAP_DemoNewsShow.xsl"

Returns:

true if the XSL has been modified

getXSLLastModified

public java.util.Date getXSLLastModified(java.lang.String ProjectID,
                                         java.lang.String XSLName)

Deprecated.

return modification date of a transformation of a given project

Parameters:

ProjectID - xml forms project id e.g. "SAP_DemoNews"

XSLName - xml forms xsl name e.g. "SAP_DemoNewsShow.xsl"

Returns:

modification date of the XSL or null if the XSL does not exists or is not accessible

checkGlobalResourceFile

public boolean checkGlobalResourceFile(java.lang.String name)

Deprecated.

Check if a global resource file exists for a given language.

Parameters:

name - name of the global resource file e.g. gloabalresource_en.xml

Returns:

true if the file exists, false otherwise