com.sap.engine.interfaces.messaging.api

Interface XMLPayload

All Superinterfaces:

Payload, TextPayload

public interface XMLPayload
extends TextPayload

The XMLPayload extends the TextPayload interface and specializes for the XML only document.

Method Summary

Modifier and Type	Method and Description
String	getSchema() Returns XML document schema URL.
String	getVersion() Returns the version of this payload.
void	setSchema(String schema) Sets the parameter containing a URL to an XML document schema.
void	setVersion(String version) Sets the version of this payload.

Methods inherited from interface com.sap.engine.interfaces.messaging.api.TextPayload

getEncoding, getReader, getText, setContent, setText, setText

Methods inherited from interface com.sap.engine.interfaces.messaging.api.Payload

clearAttributes, getAttribute, getAttributeNames, getContent, getContentType, getDescription, getInputStream, getName, removeAttribute, setAttribute, setContent, setContentType, setDescription, setName

Method Detail

getVersion

String getVersion()

Returns the version of this payload.

Returns:

String version.

setVersion

void setVersion(String version)
         throws InvalidParamException

Sets the version of this payload.

Parameters:

version - Sets the version of this payload

Throws:

InvalidParamException - if the version is invalid.

getSchema

String getSchema()

Returns XML document schema URL.

Returns:

URL to the schema.

setSchema

void setSchema(String schema)
        throws InvalidParamException

Sets the parameter containing a URL to an XML document schema.

Parameters:

schema - URL to a schema.

Throws:

InvalidParamException - if the schema is invalid.