com.sapportals.wcm.service.xmlforms
Interface IXMLForm

[contained in: com.sap.km.cm.service.base.par - km.shared.service.xmlforms_api.jar] Deprecated. use IXFService, IXFProject and IXFTransformation instead

public interface IXMLForm

Copyright 2004 SAP AG

Method Summary

boolean	canPost() Deprecated. true if postXMLData is supported
boolean	canRespond() Deprecated. true if sendHtmlRespond is supported
boolean	checkXMLDataExistence() Deprecated. check if XML data exists
java.lang.String	getAction() Deprecated.
java.util.Locale	getClientLocale() Deprecated.
java.lang.String	getEncoding() Deprecated.
java.lang.String	getFormMimeType() Deprecated.
java.io.InputStream	getFormStream() Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(boolean allowEdit) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(boolean allowEdit, java.util.HashMap extproperties) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(boolean allowEdit, java.util.HashMap extproperties, java.lang.String XSLName) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(boolean allowEdit, java.lang.String XSLName) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(java.util.HashMap extproperties) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(java.util.HashMap extproperties, java.lang.String XSLName) Deprecated. get a html stream of the form
java.io.InputStream	getFormStream(java.lang.String XSLName) Deprecated. get a html stream of the form
java.lang.String	getID() Deprecated. shortname of the form
java.lang.String	getImagePath() Deprecated.
java.io.InputStream	getListStream() Deprecated. get a html listing of the items
java.io.InputStream	getListStream(java.util.HashMap extparameters) Deprecated. get a html listing of the items
java.io.InputStream	getListStream(java.util.HashMap extparameters, java.lang.String XSLName) Deprecated. get a html listing of the items
java.io.InputStream	getListStream(java.lang.String XSLName) Deprecated. get a html listing of the items
java.lang.String	getName() Deprecated. descritive name of the form
java.util.HashMap	getParameters() Deprecated. define a set of parameters which are to be generated as hidden form fields
boolean	getRename() Deprecated.
IResourceContext	getResourceContext() Deprecated.
java.lang.String	getResourceType() Deprecated.
java.lang.String	getRespondMimeType() Deprecated.
java.io.InputStream	getRespondStream() Deprecated. get a html stream of the form
java.io.InputStream	getRespondStream(java.util.HashMap extproperties) Deprecated. get a html stream of the form
java.util.Map	getShowForms() Deprecated.
boolean	getStoreOnValidationError() Deprecated.
java.lang.String	getSubmitMethod() Deprecated.
IResourceContext	getSystemResourceContext() Deprecated.
java.lang.String	getTemplatePath() Deprecated.
boolean	getUseMetaXMLFormat() Deprecated.
boolean	getValidation() Deprecated.
java.lang.String	getValidationErrorList() Deprecated. XML string containing all validation errors see XMLValidator for more information on the format of the XML stream
int	getValidationErrorNumber() Deprecated. number of validation errors
java.io.InputStream	getValidationErrorStream() Deprecated. XML stream with error information tags see XMLValidator for more information on the format of the XML stream
java.lang.String	getXMLDataAbsolute() Deprecated.
java.lang.String	getXMLDataExtension() Deprecated.
java.lang.String	getXMLDataName() Deprecated.
java.lang.String	getXMLDataPath() Deprecated.
java.lang.String	getXMLTemplateName() Deprecated.
java.lang.String	getXSLCreateStyle() Deprecated.
java.lang.String	getXSLListStyle() Deprecated.
java.lang.String	getXSLPostStyle() Deprecated.
java.lang.String	getXSLPropCreateStyle() Deprecated. name of the XSL Stylesheet to generate the resource properties form
java.lang.String	getXSLPropShowStyle() Deprecated. name of the XSL Stylesheet to generate the resource properties form
java.lang.String	getXSLRespondStyle() Deprecated.
java.lang.String	getXSLShowStyle() Deprecated.
boolean	postXMLData(java.io.InputStream XMLinputStream) Deprecated. post the form to the
boolean	postXMLData(java.io.InputStream XMLinputStream, java.util.HashMap extproperties) Deprecated. post the form to the
void	setAction(java.lang.String action) Deprecated. the callback URL for then form
void	setClientLocale(java.util.Locale clientlocale) Deprecated. client locale
void	setDataTypes(java.util.HashMap map) Deprecated. set HashMap with data types
void	setImagePath(java.lang.String imagepath) Deprecated. image path
void	setNSMaps(java.util.HashMap alias2ns, java.util.HashMap ns2alias) Deprecated.
void	setOriginalResourceNames(java.lang.String orgname, java.lang.String resname) Deprecated.
void	setRename(boolean value) Deprecated. flag to switch on/off renaming, default is false
void	setResourceContext(IResourceContext resourcecontext) Deprecated. resource context
void	setResourceType(java.lang.String name) Deprecated. XML data resoure path
void	setStoreOnValidationError(boolean value) Deprecated. store even if validation failes
void	setSubmitMethod(java.lang.String method) Deprecated. the submit method to by used by the form i.e.
void	setSystemResourceContext(IResourceContext systemrescontext) Deprecated. system resource context
void	setUseMetaXMLFormat(boolean value) Deprecated. Single XSL is used to generate the form
void	setValidation(boolean value) Deprecated. flag to switch on/off validation, default is true
void	setXMLDataAbsolute(java.lang.String uri) Deprecated. XML absolute data uri for existing resources setting will set DataPath, DataName and DataExtension accordingly
void	setXMLDataExtension(java.lang.String name) Deprecated. XML data resoure extension
void	setXMLDataName(java.lang.String name) Deprecated. XML data resoure
void	setXMLDataPath(java.lang.String name) Deprecated. XML data resoure path
void	setXMLDataStream(java.io.InputStream in) Deprecated.
void	setXMLTemplateName(java.lang.String name) Deprecated. name of the XML template
void	setXSLCreateStyle(java.lang.String name) Deprecated. name of the XSL stylesheet to create the data form
void	setXSLListStyle(java.lang.String name) Deprecated. name of the XSL stylesheet to display the data
void	setXSLRespondStyle(java.lang.String name) Deprecated. name of the XSL stylesheet to generate the respond
void	setXSLShowStyle(java.lang.String name) Deprecated. name of the XSL stylesheet to display the data
java.io.InputStream	validateXMLData(javax.servlet.http.HttpServletRequest request) Deprecated. post the form to the
java.io.InputStream	validateXMLData(javax.servlet.http.HttpServletRequest request, java.util.HashMap extproperties) Deprecated. post the form to the
java.io.InputStream	validateXMLData(java.io.InputStream XMLinputStream) Deprecated. post the form to the
java.io.InputStream	validateXMLData(java.io.InputStream XMLinputStream, java.util.HashMap extproperties) Deprecated. post the form to the

Method Detail

getName

public java.lang.String getName()

Deprecated.

descritive name of the form

getID

public java.lang.String getID()

Deprecated.

shortname of the form

setSubmitMethod

public void setSubmitMethod(java.lang.String method)

Deprecated.

the submit method to by used by the form i.e. GET or POST

getSubmitMethod

public java.lang.String getSubmitMethod()

Deprecated.

setImagePath

public void setImagePath(java.lang.String imagepath)

Deprecated.

image path

getImagePath

public java.lang.String getImagePath()

Deprecated.

setClientLocale

public void setClientLocale(java.util.Locale clientlocale)

Deprecated.

client locale

getClientLocale

public java.util.Locale getClientLocale()

Deprecated.

setResourceContext

public void setResourceContext(IResourceContext resourcecontext)

Deprecated.

resource context

getResourceContext

public IResourceContext getResourceContext()

Deprecated.

setSystemResourceContext

public void setSystemResourceContext(IResourceContext systemrescontext)

Deprecated.

system resource context

getSystemResourceContext

public IResourceContext getSystemResourceContext()

Deprecated.

setAction

public void setAction(java.lang.String action)

Deprecated.

the callback URL for then form

getAction

public java.lang.String getAction()

Deprecated.

getParameters

public java.util.HashMap getParameters()

Deprecated.

define a set of parameters which are to be generated as hidden form fields

getTemplatePath

public java.lang.String getTemplatePath()

Deprecated.

setXMLTemplateName

public void setXMLTemplateName(java.lang.String name)

Deprecated.

name of the XML template

getXMLTemplateName

public java.lang.String getXMLTemplateName()

Deprecated.

setXSLCreateStyle

public void setXSLCreateStyle(java.lang.String name)

Deprecated.

name of the XSL stylesheet to create the data form

getXSLCreateStyle

public java.lang.String getXSLCreateStyle()

Deprecated.

setXSLShowStyle

public void setXSLShowStyle(java.lang.String name)

Deprecated.

name of the XSL stylesheet to display the data

getXSLShowStyle

public java.lang.String getXSLShowStyle()

Deprecated.

setXSLListStyle

public void setXSLListStyle(java.lang.String name)

Deprecated.

name of the XSL stylesheet to display the data

getXSLListStyle

public java.lang.String getXSLListStyle()

Deprecated.

setXSLRespondStyle

public void setXSLRespondStyle(java.lang.String name)

Deprecated.

name of the XSL stylesheet to generate the respond

getXSLRespondStyle

public java.lang.String getXSLRespondStyle()

Deprecated.

getXSLPostStyle

public java.lang.String getXSLPostStyle()

Deprecated.

getXSLPropCreateStyle

public java.lang.String getXSLPropCreateStyle()

Deprecated.

name of the XSL Stylesheet to generate the resource properties form

getXSLPropShowStyle

public java.lang.String getXSLPropShowStyle()

Deprecated.

name of the XSL Stylesheet to generate the resource properties form

setUseMetaXMLFormat

public void setUseMetaXMLFormat(boolean value)

Deprecated.

Single XSL is used to generate the form

getUseMetaXMLFormat

public boolean getUseMetaXMLFormat()

Deprecated.

setXMLDataAbsolute

public void setXMLDataAbsolute(java.lang.String uri)

Deprecated.

XML absolute data uri for existing resources setting will set DataPath, DataName and DataExtension accordingly

getXMLDataAbsolute

public java.lang.String getXMLDataAbsolute()

Deprecated.

setXMLDataPath

public void setXMLDataPath(java.lang.String name)

Deprecated.

XML data resoure path

getXMLDataPath

public java.lang.String getXMLDataPath()

Deprecated.

setResourceType

public void setResourceType(java.lang.String name)

Deprecated.

XML data resoure path

getResourceType

public java.lang.String getResourceType()

Deprecated.

setXMLDataName

public void setXMLDataName(java.lang.String name)
                    throws XMLFormException,
                           java.lang.Exception

Deprecated.

XML data resoure

getXMLDataName

public java.lang.String getXMLDataName()

Deprecated.

setXMLDataExtension

public void setXMLDataExtension(java.lang.String name)

Deprecated.

XML data resoure extension

getXMLDataExtension

public java.lang.String getXMLDataExtension()

Deprecated.

setXMLDataStream

public void setXMLDataStream(java.io.InputStream in)

Deprecated.

checkXMLDataExistence

public boolean checkXMLDataExistence()

Deprecated.

check if XML data exists

canRespond

public boolean canRespond()

Deprecated.

true if sendHtmlRespond is supported

canPost

public boolean canPost()

Deprecated.

true if postXMLData is supported

getFormMimeType

public java.lang.String getFormMimeType()

Deprecated.

getRespondMimeType

public java.lang.String getRespondMimeType()

Deprecated.

getValidationErrorList

public java.lang.String getValidationErrorList()

Deprecated.

XML string containing all validation errors see XMLValidator for more information on the format of the XML stream

getValidationErrorStream

public java.io.InputStream getValidationErrorStream()

Deprecated.

XML stream with error information tags see XMLValidator for more information on the format of the XML stream

getValidationErrorNumber

public int getValidationErrorNumber()

Deprecated.

number of validation errors

setRename

public void setRename(boolean value)

Deprecated.

flag to switch on/off renaming, default is false

getRename

public boolean getRename()

Deprecated.

setValidation

public void setValidation(boolean value)

Deprecated.

flag to switch on/off validation, default is true

getValidation

public boolean getValidation()

Deprecated.

setStoreOnValidationError

public void setStoreOnValidationError(boolean value)

Deprecated.

store even if validation failes

getStoreOnValidationError

public boolean getStoreOnValidationError()

Deprecated.

setDataTypes

public void setDataTypes(java.util.HashMap map)

Deprecated.

set HashMap with data types

getEncoding

public java.lang.String getEncoding()

Deprecated.

getShowForms

public java.util.Map getShowForms()

Deprecated.

setOriginalResourceNames

public void setOriginalResourceNames(java.lang.String orgname,
                                     java.lang.String resname)

Deprecated.

setNSMaps

public void setNSMaps(java.util.HashMap alias2ns,
                      java.util.HashMap ns2alias)

Deprecated.

getFormStream

public java.io.InputStream getFormStream()
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(java.util.HashMap extproperties)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(boolean allowEdit)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(boolean allowEdit,
                                         java.util.HashMap extproperties)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(java.util.HashMap extproperties,
                                         java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(boolean allowEdit,
                                         java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getFormStream

public java.io.InputStream getFormStream(boolean allowEdit,
                                         java.util.HashMap extproperties,
                                         java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html stream of the form

getListStream

public java.io.InputStream getListStream()
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html listing of the items

getListStream

public java.io.InputStream getListStream(java.util.HashMap extparameters)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html listing of the items

getListStream

public java.io.InputStream getListStream(java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html listing of the items

getListStream

public java.io.InputStream getListStream(java.util.HashMap extparameters,
                                         java.lang.String XSLName)
                                  throws XMLFormException,
                                         java.io.IOException,
                                         java.lang.Exception

Deprecated.

get a html listing of the items

postXMLData

public boolean postXMLData(java.io.InputStream XMLinputStream)
                    throws XMLFormException,
                           java.io.IOException,
                           java.lang.Exception

Deprecated.

post the form to the

postXMLData

public boolean postXMLData(java.io.InputStream XMLinputStream,
                           java.util.HashMap extproperties)
                    throws XMLFormException,
                           java.io.IOException,
                           java.lang.Exception

Deprecated.

post the form to the

validateXMLData

public java.io.InputStream validateXMLData(java.io.InputStream XMLinputStream)
                                    throws XMLFormException,
                                           java.io.IOException,
                                           java.lang.Exception

Deprecated.

post the form to the

validateXMLData

public java.io.InputStream validateXMLData(java.io.InputStream XMLinputStream,
                                           java.util.HashMap extproperties)
                                    throws XMLFormException,
                                           java.io.IOException,
                                           java.lang.Exception

Deprecated.

post the form to the

validateXMLData

public java.io.InputStream validateXMLData(javax.servlet.http.HttpServletRequest request)
                                    throws XMLFormException,
                                           java.io.IOException,
                                           java.lang.Exception

Deprecated.

post the form to the

validateXMLData

public java.io.InputStream validateXMLData(javax.servlet.http.HttpServletRequest request,
                                           java.util.HashMap extproperties)
                                    throws XMLFormException,
                                           java.io.IOException,
                                           java.lang.Exception

Deprecated.

post the form to the

getRespondStream

public java.io.InputStream getRespondStream()
                                     throws XMLFormException,
                                            java.io.IOException,
                                            java.lang.Exception

Deprecated.

get a html stream of the form

getRespondStream

public java.io.InputStream getRespondStream(java.util.HashMap extproperties)
                                     throws XMLFormException,
                                            java.io.IOException,
                                            java.lang.Exception

Deprecated.

get a html stream of the form