com.sapportals.wcm.service.xmlforms

Interface IXMLForm

Deprecated.

use IXFService, IXFProject and IXFTransformation instead

public interface IXMLForm

Copyright 2004 SAP AG

Method Summary

Modifier and Type	Method and Description
boolean	canPost() Deprecated. true if postXMLData is supported
boolean	canRespond() Deprecated. true if sendHtmlRespond is supported
boolean	checkXMLDataExistence() Deprecated. check if XML data exists
String	getAction() Deprecated. Returns the callback URL for then form
Locale	getClientLocale() Deprecated. Returns the client locale
String	getEncoding() Deprecated.
String	getFormMimeType() Deprecated.
InputStream	getFormStream() Deprecated. Returns a html stream of the form
InputStream	getFormStream(boolean allowEdit) Deprecated. Returns a html stream of the form
InputStream	getFormStream(boolean allowEdit, HashMap extproperties) Deprecated. Returns a html stream of the form
InputStream	getFormStream(boolean allowEdit, HashMap extproperties, String XSLName) Deprecated. Returns a html stream of the form
InputStream	getFormStream(boolean allowEdit, String XSLName) Deprecated. Returns a html stream of the form
InputStream	getFormStream(HashMap extproperties) Deprecated. Returns a html stream of the form
InputStream	getFormStream(HashMap extproperties, String XSLName) Deprecated. Returns a html stream of the form
InputStream	getFormStream(String XSLName) Deprecated. Returns a html stream of the form
String	getID() Deprecated. Returns shortname of the form
String	getImagePath() Deprecated. Returns the image path
InputStream	getListStream() Deprecated. Returns a html listing of the items
InputStream	getListStream(HashMap extparameters) Deprecated. Returns a html listing of the items
InputStream	getListStream(HashMap extparameters, String XSLName) Deprecated. Returns a html listing of the items
InputStream	getListStream(String XSLName) Deprecated. Returns a html listing of the items
String	getName() Deprecated. Returns descritive name of the form
HashMap	getParameters() Deprecated. Define a set of parameters which are to be generated as hidden form fields
boolean	getRename() Deprecated.
IResourceContext	getResourceContext() Deprecated. Returns the resource context
String	getResourceType() Deprecated.
String	getRespondMimeType() Deprecated.
InputStream	getRespondStream() Deprecated.
InputStream	getRespondStream(HashMap extproperties) Deprecated.
Map	getShowForms() Deprecated.
boolean	getStoreOnValidationError() Deprecated.
String	getSubmitMethod() Deprecated. Returns the submit method
IResourceContext	getSystemResourceContext() Deprecated. Returns the system resource context
String	getTemplatePath() Deprecated. Returns the path to the template
boolean	getUseMetaXMLFormat() Deprecated. Returns use meta xml format
boolean	getValidation() Deprecated.
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
InputStream	getValidationErrorStream() Deprecated. XML stream with error information tags see XMLValidator for more information on the format of the XML stream
String	getXMLDataAbsolute() Deprecated.
String	getXMLDataExtension() Deprecated.
String	getXMLDataName() Deprecated.
String	getXMLDataPath() Deprecated.
String	getXMLTemplateName() Deprecated. Returns the name of the XML temple
String	getXSLCreateStyle() Deprecated. Returns the name of the XSL stylesheet to create the data form
String	getXSLListStyle() Deprecated. Returns the XSL stylesheet to display the data
String	getXSLPostStyle() Deprecated. Returns the name of the XSL stylesheet to generate the post data
String	getXSLPropCreateStyle() Deprecated. Returns the name of the XSL Stylesheet to generate the resource properties form
String	getXSLPropShowStyle() Deprecated. Returns the name of the XSL Stylesheet to generate the resource properties form
String	getXSLRespondStyle() Deprecated. Returns the name of the XSL stylesheet to generate the respond
String	getXSLShowStyle() Deprecated.
boolean	postXMLData(InputStream XMLinputStream) Deprecated. Posts an XML form
boolean	postXMLData(InputStream XMLinputStream, HashMap extproperties) Deprecated. Posts an XML form
void	setAction(String action) Deprecated. Sets the callback URL for then form
void	setClientLocale(Locale clientlocale) Deprecated. Sets the client locale
void	setDataTypes(HashMap map) Deprecated. set HashMap with data types
void	setImagePath(String imagepath) Deprecated. Sets the image pat
void	setNSMaps(HashMap alias2ns, HashMap ns2alias) Deprecated.
void	setOriginalResourceNames(String orgname, String resname) Deprecated.
void	setRename(boolean value) Deprecated. flag to switch on/off renaming, default is false
void	setResourceContext(IResourceContext resourcecontext) Deprecated. Sets the resource context
void	setResourceType(String name) Deprecated. XML data resoure path
void	setStoreOnValidationError(boolean value) Deprecated. store even if validation failes
void	setSubmitMethod(String method) Deprecated. Sets the submit method to by used by the form (GET or POST)
void	setSystemResourceContext(IResourceContext systemrescontext) Deprecated. Sets the system resource context
void	setUseMetaXMLFormat(boolean value) Deprecated. Not supported
void	setValidation(boolean value) Deprecated. flag to switch on/off validation, default is true
void	setXMLDataAbsolute(String uri) Deprecated. Sets DataPath, DataName and DataExtension accordingly from an uri
void	setXMLDataExtension(String name) Deprecated. XML data resoure extension
void	setXMLDataName(String name) Deprecated. XML data resoure
void	setXMLDataPath(String name) Deprecated. XML data resoure path
void	setXMLDataStream(InputStream in) Deprecated.
void	setXMLTemplateName(String name) Deprecated. Sets the name of the XML template
void	setXSLCreateStyle(String name) Deprecated. Sets the name of the XSL stylesheet to create the data form
void	setXSLListStyle(String name) Deprecated. Sets the XSL stylesheet to display the data
void	setXSLRespondStyle(String name) Deprecated. Sets the name of the XSL stylesheet to generate the respond
void	setXSLShowStyle(String name) Deprecated. name of the XSL stylesheet to display the data
InputStream	validateXMLData(HttpServletRequest request) Deprecated.
InputStream	validateXMLData(HttpServletRequest request, HashMap extproperties) Deprecated.
InputStream	validateXMLData(InputStream XMLinputStream) Deprecated.
InputStream	validateXMLData(InputStream XMLinputStream, HashMap extproperties) Deprecated.

Method Detail

getName

String getName()

Deprecated.

Returns descritive name of the form

Returns:

the image path

getID

String getID()

Deprecated.

Returns shortname of the form

Returns:

id

setSubmitMethod

void setSubmitMethod(String method)

Deprecated.

Sets the submit method to by used by the form (GET or POST)

Parameters:

method - The method to be used by the form

getSubmitMethod

String getSubmitMethod()

Deprecated.

Returns the submit method

Returns:

The submit method (GET or POST)

setImagePath

void setImagePath(String imagepath)

Deprecated.

Sets the image pat

Parameters:

imagepath - The image path

getImagePath

String getImagePath()

Deprecated.

Returns the image path

Returns:

The image path

setClientLocale

void setClientLocale(Locale clientlocale)

Deprecated.

Sets the client locale

Parameters:

clientlocale - The client locale

getClientLocale

Locale getClientLocale()

Deprecated.

Returns the client locale

Returns:

The client locale

setResourceContext

void setResourceContext(IResourceContext resourcecontext)

Deprecated.

Sets the resource context

Parameters:

resourcecontext - The resource context

getResourceContext

IResourceContext getResourceContext()

Deprecated.

Returns the resource context

Returns:

the resource context

setSystemResourceContext

void setSystemResourceContext(IResourceContext systemrescontext)

Deprecated.

Sets the system resource context

Parameters:

systemrescontext -

getSystemResourceContext

IResourceContext getSystemResourceContext()

Deprecated.

Returns the system resource context

Returns:

The system resource context

setAction

void setAction(String action)

Deprecated.

Sets the callback URL for then form

Parameters:

action - The callback URL for then form

getAction

String getAction()

Deprecated.

Returns the callback URL for then form

Returns:

The callback URL for then form

getParameters

HashMap getParameters()

Deprecated.

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

Returns:

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

getTemplatePath

String getTemplatePath()

Deprecated.

Returns the path to the template

Returns:

The path to the template

setXMLTemplateName

void setXMLTemplateName(String name)

Deprecated.

Sets the name of the XML template

Parameters:

name - The name of the XML template

getXMLTemplateName

String getXMLTemplateName()

Deprecated.

Returns the name of the XML temple

Returns:

The name of the XML template

setXSLCreateStyle

void setXSLCreateStyle(String name)

Deprecated.

Sets the name of the XSL stylesheet to create the data form

Parameters:

name - The name of the XSL stylesheet to create the data form

getXSLCreateStyle

String getXSLCreateStyle()

Deprecated.

Returns the name of the XSL stylesheet to create the data form

Returns:

The name of the XSL stylesheet to create the data form

setXSLShowStyle

void setXSLShowStyle(String name)

Deprecated.

name of the XSL stylesheet to display the data

getXSLShowStyle

String getXSLShowStyle()

Deprecated.

setXSLListStyle

void setXSLListStyle(String name)

Deprecated.

Sets the XSL stylesheet to display the data

Parameters:

name - The XSL stylesheet to display the data

getXSLListStyle

String getXSLListStyle()

Deprecated.

Returns the XSL stylesheet to display the data

Returns:

The XSL stylesheet to display the data

setXSLRespondStyle

void setXSLRespondStyle(String name)

Deprecated.

Sets the name of the XSL stylesheet to generate the respond

Parameters:

name - the name of the XSL stylesheet to generate the respond

getXSLRespondStyle

String getXSLRespondStyle()

Deprecated.

Returns the name of the XSL stylesheet to generate the respond

Returns:

The name of the XSL stylesheet to generate the respond

getXSLPostStyle

String getXSLPostStyle()

Deprecated.

Returns the name of the XSL stylesheet to generate the post data

Returns:

The name of the XSL stylesheet to generate the post data

getXSLPropCreateStyle

String getXSLPropCreateStyle()

Deprecated.

Returns the name of the XSL Stylesheet to generate the resource properties form

Returns:

The name of the XSL Stylesheet to generate the resource properties form

getXSLPropShowStyle

String getXSLPropShowStyle()

Deprecated.

Returns the name of the XSL Stylesheet to generate the resource properties form

Returns:

The name of the XSL Stylesheet to generate the resource properties form

setUseMetaXMLFormat

void setUseMetaXMLFormat(boolean value)

Deprecated.

Not supported

Parameters:

value - not supported

getUseMetaXMLFormat

boolean getUseMetaXMLFormat()

Deprecated.

Returns use meta xml format

Returns:

true

setXMLDataAbsolute

void setXMLDataAbsolute(String uri)

Deprecated.

Sets DataPath, DataName and DataExtension accordingly from an uri

Parameters:

uri - XML absolute data uri for existing resources

getXMLDataAbsolute

String getXMLDataAbsolute()

Deprecated.

setXMLDataPath

void setXMLDataPath(String name)

Deprecated.

XML data resoure path

getXMLDataPath

String getXMLDataPath()

Deprecated.

setResourceType

void setResourceType(String name)

Deprecated.

XML data resoure path

getResourceType

String getResourceType()

Deprecated.

setXMLDataName

void setXMLDataName(String name)
             throws XMLFormException,
                    Exception

Deprecated.

XML data resoure

Throws:

XMLFormException

Exception

getXMLDataName

String getXMLDataName()

Deprecated.

setXMLDataExtension

void setXMLDataExtension(String name)

Deprecated.

XML data resoure extension

getXMLDataExtension

String getXMLDataExtension()

Deprecated.

setXMLDataStream

void setXMLDataStream(InputStream in)

Deprecated.

checkXMLDataExistence

boolean checkXMLDataExistence()

Deprecated.

check if XML data exists

canRespond

boolean canRespond()

Deprecated.

true if sendHtmlRespond is supported

canPost

boolean canPost()

Deprecated.

true if postXMLData is supported

getFormMimeType

String getFormMimeType()

Deprecated.

getRespondMimeType

String getRespondMimeType()

Deprecated.

getValidationErrorList

String getValidationErrorList()

Deprecated.

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

getValidationErrorStream

InputStream getValidationErrorStream()

Deprecated.

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

getValidationErrorNumber

int getValidationErrorNumber()

Deprecated.

number of validation errors

setRename

void setRename(boolean value)

Deprecated.

flag to switch on/off renaming, default is false

getRename

boolean getRename()

Deprecated.

setValidation

void setValidation(boolean value)

Deprecated.

flag to switch on/off validation, default is true

getValidation

boolean getValidation()

Deprecated.

setStoreOnValidationError

void setStoreOnValidationError(boolean value)

Deprecated.

store even if validation failes

getStoreOnValidationError

boolean getStoreOnValidationError()

Deprecated.

setDataTypes

void setDataTypes(HashMap map)

Deprecated.

set HashMap with data types

getEncoding

String getEncoding()

Deprecated.

getShowForms

Map getShowForms()

Deprecated.

setOriginalResourceNames

void setOriginalResourceNames(String orgname,
                              String resname)

Deprecated.

setNSMaps

void setNSMaps(HashMap alias2ns,
               HashMap ns2alias)

Deprecated.

getFormStream

InputStream getFormStream()
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(HashMap extproperties)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

extproperties -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(boolean allowEdit)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

allowEdit -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(boolean allowEdit,
                          HashMap extproperties)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

allowEdit -

extproperties -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

XSLName -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(HashMap extproperties,
                          String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

extproperties -

XSLName -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(boolean allowEdit,
                          String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

allowEdit -

XSLName -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getFormStream

InputStream getFormStream(boolean allowEdit,
                          HashMap extproperties,
                          String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html stream of the form

Parameters:

allowEdit -

extproperties -

XSLName -

Returns:

A html stream of the form

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getListStream

InputStream getListStream()
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html listing of the items

Returns:

A html listing of the items

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getListStream

InputStream getListStream(HashMap extparameters)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html listing of the items

Parameters:

extparameters -

Returns:

A html listing of the items

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getListStream

InputStream getListStream(String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html listing of the items

Parameters:

XSLName -

Returns:

A html listing of the items

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getListStream

InputStream getListStream(HashMap extparameters,
                          String XSLName)
                   throws XMLFormException,
                          IOException,
                          Exception

Deprecated.

Returns a html listing of the items

Parameters:

extparameters -

XSLName -

Returns:

A html listing of the items

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

postXMLData

boolean postXMLData(InputStream XMLinputStream)
             throws XMLFormException,
                    IOException,
                    Exception

Deprecated.

Posts an XML form

Parameters:

XMLinputStream - The XML form input stream

Returns:

result of the operation

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

postXMLData

boolean postXMLData(InputStream XMLinputStream,
                    HashMap extproperties)
             throws XMLFormException,
                    IOException,
                    Exception

Deprecated.

Posts an XML form

Parameters:

XMLinputStream -

extproperties -

Returns:

true if post data succeeded, false otherwise

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

validateXMLData

InputStream validateXMLData(InputStream XMLinputStream)
                     throws XMLFormException,
                            IOException,
                            Exception

Deprecated.

Parameters:

XMLinputStream -

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

validateXMLData

InputStream validateXMLData(InputStream XMLinputStream,
                            HashMap extproperties)
                     throws XMLFormException,
                            IOException,
                            Exception

Deprecated.

Parameters:

XMLinputStream -

extproperties -

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

validateXMLData

InputStream validateXMLData(HttpServletRequest request)
                     throws XMLFormException,
                            IOException,
                            Exception

Deprecated.

Parameters:

request -

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

validateXMLData

InputStream validateXMLData(HttpServletRequest request,
                            HashMap extproperties)
                     throws XMLFormException,
                            IOException,
                            Exception

Deprecated.

Parameters:

request -

extproperties -

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getRespondStream

InputStream getRespondStream()
                      throws XMLFormException,
                             IOException,
                             Exception

Deprecated.

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred

getRespondStream

InputStream getRespondStream(HashMap extproperties)
                      throws XMLFormException,
                             IOException,
                             Exception

Deprecated.

Parameters:

extproperties -

Returns:

input stream

Throws:

XMLFormException - if an error occurred

IOException - if an error occurred

Exception - if an error occurred