oracle.panama.rt
Interface ServiceContext

All Superinterfaces:

BillingContext, ProcessingContext, ProcessingContextParameterNames

public interface ServiceContext

extends ProcessingContext, BillingContext

This interface represents the ServiceContext objects in PTG Runtime.

Since:

Oracle9i Application Server Wireless Edition

Field Summary

Fields inherited from interface oracle.panama.rt.ProcessingContextParameterNames

ABS_REQUEST_NAME, ACCEPT_LANG, AMP_EXPLICIT, BASE_URL, COUNTRY, DEVICE, DEVICE_CATEGORY, ENC_SUFFIX, FIRST_ACCEPT_LANG, HTTP_REQUEST_NAME, HTTPS_REQUEST_NAME, IMAGE_PREFERENCES, INP_FIRST_SERVICE_NAME, INP_FIRST_SERVICE_NAME_ENC, INP_FIRST_SERVICE_URL, INP_FIRST_SERVICE_URL_ENC, LATITUDE, LONGITUDE, MAX_DOC_SIZE, POSTALCODE, REFERER_URL, REQUEST_NAME, RESULT, SCREEN_COLS, SCREEN_HEIGHT, SCREEN_ROWS, SCREEN_WIDTH, SERVICE_REQUEST, SESSION, SOFT_KEYS, SR_FROM_ADAPTER, SR_FROM_SERVICE, STATE, USER, USER_AGENT, USER_LANGUAGE

Fields inherited from interface oracle.wireless.billing.BillingContext

ALERT_COMPONENT, MESSAGING_COMPONENT, PROVISIONING_COMPONENT, PUSH_COMPONENT, RUNTIME_COMPONENT

Method Summary

org.w3c.dom.Element	getAdapterResult()
java.lang.String	getAdapterResultString() Get the string result of the invocation of the adapter.
Folder	getCurrentFolder() Get the current folder
Device	getDevice() Get the device object representing the capability of the user agent that issues the request.
org.w3c.dom.Element	getElement(org.w3c.dom.Document owner) Externalize the contents of ServiceContext in XML doument format.
java.lang.String	getExceptionMessage() Get the diagnostic message from XML transformers and parsers.
Arguments	getInputArguments() Get an array of input arguments for the service.
OutputArguments	getOutputArguments()
Profile	getProfile() Get the user profile for the request.
Request	getRequest() Get the request that initiated the service invocation context.
Response	getResponse() Get the response that will receive the output from service invocation.
ResultType	getResultType() Get the type of the current result.
java.lang.String	getSection()
java.lang.String	getServerInfo() Get the name and version of the server software, separated by a forward slash (/).
Service	getService() Get the service to be invoked for the current request.
java.lang.String	getServiceHomeURL()
java.lang.String	getServiceParentURL()
Session	getSession() Get the session for the service context.
java.lang.String	getSimpleResultString() * @deprecated As of IAS 9.0.3, replaced by ProcessingContext.getMarkupLanguageVersion() Get the string for the simple result.
java.lang.String	getUserHomeURL()
java.lang.String	getXHTMLResultString() Get the string for the XHTML result.
org.w3c.dom.Document	getXMLDocument() Get the XML document to contain all dom elements created for this context.
boolean	isAnyResultPresent() Check if the results are suppressed
void	setAdapterResult(org.w3c.dom.Element result)
void	setAnyResultPresent(boolean present) This flag is normally true, but can be changed to false to suppress the output results.
void	setExceptionMessage(java.lang.String msg) Set the diagnostic message from XML transformers and parsers.
void	setInputArguments(Arguments args) Set the input arguments for the service.
void	setOutputArguments(OutputArguments args)

Methods inherited from interface oracle.panama.rt.ProcessingContext

getBinaryDeviceResult, getDeviceResult, getDeviceResultLength, getDeviceResultType, getElement, getMarkupLanguageVersion, getMPResult, getRequestedXFormsDocument, getRespondedXFormsDocument, getSimpleResult, getSRDTDVersion, getXADResult, getXFXCResult, getXHTMLResult, setDeviceResult, setDeviceResult, setDeviceResult, setMPResult, setSimpleResult, setXADResult, setXFXCResult, setXHTMLResult

Method Detail

getAdapterResult

public org.w3c.dom.Element getAdapterResult()

Returns:

the root element of the XML document for adapter result

getAdapterResultString

public java.lang.String getAdapterResultString()

Get the string result of the invocation of the adapter.

Returns:

the formatted string for adapter result

getCurrentFolder

public Folder getCurrentFolder()

Get the current folder

Returns:

Folder current folder

getDevice

public Device getDevice()

Get the device object representing the capability of the user agent that issues the request.

Returns:

the associated device model

getElement

public org.w3c.dom.Element getElement(org.w3c.dom.Document owner)

Externalize the contents of ServiceContext in XML doument format. This may include adapter result, simple result, and all arguments that also include service, device, user, and query parameters.

Parameters:

owner - the output elements are to be created under the owner document

Returns:

the root element of the XML document

getExceptionMessage

public java.lang.String getExceptionMessage()

Get the diagnostic message from XML transformers and parsers.

getInputArguments

public Arguments getInputArguments()

Get an array of input arguments for the service.

Returns:

an array of input arguments

getOutputArguments

public OutputArguments getOutputArguments()

Returns:

an array of output arguments

getProfile

public Profile getProfile()

Get the user profile for the request. If no profile specified for request, then get the profile for the session.

getRequest

public Request getRequest()

Get the request that initiated the service invocation context.

Returns:

the request that initiated the current context

getResponse

public Response getResponse()

Get the response that will receive the output from service invocation.

Returns:

the response to receive the service invocation result

getResultType

public ResultType getResultType()

Get the type of the current result.

Returns:

ResultType the type of the current result

getSection

public java.lang.String getSection()

Returns:

the requested section name

getServerInfo

public java.lang.String getServerInfo()

Get the name and version of the server software, separated by a forward slash (/).

Returns:

the string value describing the server

getService

public Service getService()

Get the service to be invoked for the current request. The service is specified by "PAoid" or "PAservicepath" parameters.

Returns:

the requested service

getServiceHomeURL

public java.lang.String getServiceHomeURL()

Returns:

service home url

getServiceParentURL

public java.lang.String getServiceParentURL()

Returns:

containing folder url

getSession

public Session getSession()

Get the session for the service context.

Returns:

the session for the service context

getSimpleResultString

public java.lang.String getSimpleResultString()

* @deprecated As of IAS 9.0.3, replaced by ProcessingContext.getMarkupLanguageVersion() Get the string for the simple result.

Returns:

the formatted string for simple result

getUserHomeURL

public java.lang.String getUserHomeURL()

Returns:

home url;

getXHTMLResultString

public java.lang.String getXHTMLResultString()

Get the string for the XHTML result.

Returns:

the formatted string for XHTML result

getXMLDocument

public org.w3c.dom.Document getXMLDocument()

Get the XML document to contain all dom elements created for this context.

Returns:

the factory for all dom elements in the document

isAnyResultPresent

public boolean isAnyResultPresent()

Check if the results are suppressed

Returns:

false if result has been suppressed

setAdapterResult

public void setAdapterResult(org.w3c.dom.Element result)

Parameters:

result - the root element of the XML document for adapter result

setAnyResultPresent

public void setAnyResultPresent(boolean present)

This flag is normally true, but can be changed to false to suppress the output results. param present false if the results are suppressed

setExceptionMessage

public void setExceptionMessage(java.lang.String msg)

Set the diagnostic message from XML transformers and parsers.

setInputArguments

public void setInputArguments(Arguments args)

Set the input arguments for the service.

Parameters:

args - an array of input arguments for the service

setOutputArguments

public void setOutputArguments(OutputArguments args)

Parameters:

args - an array of output arguments for the service