Skip navigation links

oracle.wcps.conductor.scenario
Interface IScenarioRequest

public interface IScenarioRequest

Represents the request to the current scenario.

Nested Class Summary

static class

IScenarioRequest.Projection Defines the requested projection from the client.

Method Summary

java.lang.Object	getHttpRequest() Get the HttpServletRequest associated with the current context, if any.
java.lang.Object	getHttpResponse() Get the HttpServletResponse associated with the current context, if any.
java.util.Map<java.lang.String,?>	getInputParameters() Returns a map of input parameters associated with the current context.
java.util.Locale	getLocale() Returns the specified locale within this context.
java.lang.String	getNamespace() Returns the current namespace within the current context.
java.lang.Integer	getPageSize() Returns the page size requested by the client.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Deprecated. As of 11.1.1.5, use IScenarioRequest.getInputParameters() instead.
IScenarioRequest.Projection	getProjection() Returns the projection requested by the client.
java.lang.Integer	getStartIndex() Returns the start index requested by the client.
java.security.Principal	getUserPrincipal() Returns a java.security.Principal object containing the name of the current authenticated user.
void	setLocale(java.util.Locale locale) Sets the current locale for the current request
void	setNamespace(java.lang.String namespace) Sets the current namespace of the request.

Method Detail

getParameters

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getParameters()

Deprecated. As of 11.1.1.5, use IScenarioRequest.getInputParameters() instead.

Returns a map of input parameters associated with the current scenario context.

This method has been left in place for backward compatibility, as only values of java.lang.String were supported.

getStartIndex

java.lang.Integer getStartIndex()

Returns the start index requested by the client.

Returns:

The start index.

getPageSize

java.lang.Integer getPageSize()

Returns the page size requested by the client.

Returns:

The page size for pagination.

getProjection

IScenarioRequest.Projection getProjection()

Returns the projection requested by the client.

Returns:

The requested projection.

getUserPrincipal

java.security.Principal getUserPrincipal()

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getInputParameters

java.util.Map<java.lang.String,?> getInputParameters()

Returns a map of input parameters associated with the current context.

Each parameter value is specified as java.lang.Object

Since:

12.0.0.0

getLocale

java.util.Locale getLocale()

Returns the specified locale within this context.

Default is Locale.getDefaultLocale()

Returns:

getNamespace

java.lang.String getNamespace()

Returns the current namespace within the current context.

Returns:

The current namespace.

setNamespace

void setNamespace(java.lang.String namespace)

Sets the current namespace of the request.

Parameters:

namespace - The current namespace.

setLocale

void setLocale(java.util.Locale locale)

Sets the current locale for the current request

Parameters:

locale - The locale

getHttpRequest

java.lang.Object getHttpRequest()

Get the HttpServletRequest associated with the current context, if any.

Returns:

The HttpServletRequest if available. Null otherwise.

getHttpResponse

java.lang.Object getHttpResponse()

Get the HttpServletResponse associated with the current context, if any.

Returns:

The HttpServletResponse if available. Null otherwise.

Skip navigation links