oracle.bpel.services.workflow.verification

Interface IWorkflowContext

All Superinterfaces:

java.io.Serializable

public interface IWorkflowContext
extends java.io.Serializable

IWorkflowContext is the public interface for a Workflow Context object. It is usually created on behalf of a user after verifying the credentials with the identity authentication service. It can also be created on behalf of a process or business application for a specific task object. The Workflow Context contains the security token and other information associated with the user [such as locale, timezone etc.] / object [id]. Every operation performed on the Workflow Service requires a user's credential or a security token that denotes a Workflow Context

Method Summary

Modifier and Type	Method and Description
java.util.Locale	getDisplayNameLocale() getDisplayNameLocale returns the displayName Locale value
java.lang.String	getIdentityContext() getIdentityContext returns the identity context (typically realm) of the connected user
boolean	getIsAdmin() getIsAdmin returns a boolean denoting admin privilege of connected user
java.util.Locale	getLocale() getLocale returns the user's Locale value
java.lang.String	getObjectId() getObjectId returns the objectId that the context is associated with.
java.util.Properties	getProperties() Gets WorkflowContext property
java.lang.String	getRequester() Gets requester's user name, the name of authenticated user who requested this instance of WorkflowContext.
java.lang.String	getSessionKey() Gets workflow session key
long	getStartDateTime() Gets the time the context is created
java.util.TimeZone	getTimeZone() getTimeZone returns the user's TimeZone
java.lang.String	getToken() getToken returns the token if the user is authenticated
java.lang.String	getType() Get workflow context type
java.lang.String	getUser() getUser returns the user name of the connected user
java.lang.String	getUserDisplayName() getUserDisplayName returns the user display name
boolean	isBusinessAdmin() Returns a boolean denoting business admin privilege of connected user User has business previlege if WorkflowPermition with name "workflow.admin.business" has been granted to the user.
boolean	isManager() Returns a boolean true, if user has at least one reportee
boolean	isOnBehalf() Checks if context is on behalf of other user.
void	setDisplayNameLocale(java.util.Locale locale) setDisplayNameLocale sets the displayName Locale value
void	setLocale(java.util.Locale locale) setLocale sets the user's Locale value
void	setTimeZone(java.util.TimeZone timeZone) setTimeZone sets user's TimeZone

Method Detail

getUser

java.lang.String getUser()

getUser returns the user name of the connected user

Returns:

String The user name of the connected user

getIdentityContext

java.lang.String getIdentityContext()

getIdentityContext returns the identity context (typically realm) of the connected user

Returns:

String The identity context of the connected user

getUserDisplayName

java.lang.String getUserDisplayName()

getUserDisplayName returns the user display name

Returns:

String The user display name of the connected user

getToken

java.lang.String getToken()

getToken returns the token if the user is authenticated

Returns:

String The token if the user is authenticated

getObjectId

java.lang.String getObjectId()

getObjectId returns the objectId that the context is associated with. It returns a non null value only if the context has a valid association

Returns:

String The objectId the context is associated with

getIsAdmin

boolean getIsAdmin()

getIsAdmin returns a boolean denoting admin privilege of connected user

Returns:

boolean true if the user has admin previleges, false otherwise

isBusinessAdmin

boolean isBusinessAdmin()

Returns a boolean denoting business admin privilege of connected user User has business previlege if WorkflowPermition with name "workflow.admin.business" has been granted to the user.

Returns:

boolean true if the user has business admin previleges, false otherwise.

isManager

boolean isManager()

Returns a boolean true, if user has at least one reportee

Returns:

boolean true if the user has at least one reportee, else false

getLocale

java.util.Locale getLocale()

getLocale returns the user's Locale value

Returns:

Locale The user's locale

setLocale

void setLocale(java.util.Locale locale)

setLocale sets the user's Locale value

getDisplayNameLocale

java.util.Locale getDisplayNameLocale()

getDisplayNameLocale returns the displayName Locale value

Returns:

Locale a displayName locale value

setDisplayNameLocale

void setDisplayNameLocale(java.util.Locale locale)

setDisplayNameLocale sets the displayName Locale value

getTimeZone

java.util.TimeZone getTimeZone()

getTimeZone returns the user's TimeZone

Returns:

TimeZone The user's time zone

setTimeZone

void setTimeZone(java.util.TimeZone timeZone)

setTimeZone sets user's TimeZone

getStartDateTime

long getStartDateTime()

Gets the time the context is created

Returns:

long The time the context was created

getRequester

java.lang.String getRequester()

Gets requester's user name, the name of authenticated user who requested this instance of WorkflowContext. The access to workflow services APIs is denied if authenticated user propagated to server is not the requester.

Returns:

requester's user name

isOnBehalf

boolean isOnBehalf()

Checks if context is on behalf of other user. It returns a boolean true if context is created on behalf of other user

Returns:

boolean true if the context is created on behalf of other user, otherwise returns false

getType

java.lang.String getType()

Get workflow context type

Returns:

workflow context type

getSessionKey

java.lang.String getSessionKey()

Gets workflow session key

Returns:

workflow session key

getProperties

java.util.Properties getProperties()

Gets WorkflowContext property

Returns:

Properties instance