com.unica.publicapi.plan.api
Interface IExecutionContext

All Superinterfaces:
java.io.Serializable

public interface IExecutionContext
extends java.io.Serializable


Field Summary
static java.lang.String LOCK_ALL_FIELDS
           
 
Method Summary
 void acquireLock(Handle handle)
          This method replaces acquireLock(Handle handle, String name) method
 void acquireLock(Handle handle, java.lang.String name)
          Deprecated. use acquireLock(Handle handle) instead.
 int getOnBehalfOfUserID()
          This method provides ID of the user who has initiated the procedure execution in a triggered environment.
 IPlanAPI getPlanAPI()
          This method provides an interface to invoke all UMO public APIs
 TriggerEventTypeEnum getTriggerEvent()
          This method provides a triggered procedure with the Event that caused the trigger Returns null if not fired from a trigger
 Handle getTriggerHandle()
          This method provides a triggered procedure with the object that caused the trigger Returns null if not fired from a trigger
 int getUserID()
          This method provides ID of the user who is invoking the procedure.
 boolean isTriggerContext()
          This method notifies user if this invocation is initiated by a trigger or external API call over web-service.
 void logError(java.lang.String message)
           
 void logError(java.lang.String message, java.lang.Exception exception)
           
 void logInfo(java.lang.String message)
           
 void logWarning(java.lang.String message)
           
 void logWarning(java.lang.String message, java.lang.Exception exception)
           
 void releaseAllLocks()
           
 void releaseLock(Handle handle)
          This method replaces releaseLock(Handle handle, String name) method
 void releaseLock(Handle handle, java.lang.String name)
          Deprecated. use releaseLock(Handle handle) instead.
 

Field Detail

LOCK_ALL_FIELDS

static final java.lang.String LOCK_ALL_FIELDS
See Also:
Constant Field Values
Method Detail

getPlanAPI

IPlanAPI getPlanAPI()
This method provides an interface to invoke all UMO public APIs

Returns:
instance of IPlanAPI class

getUserID

int getUserID()
This method provides ID of the user who is invoking the procedure. Normally this would be ID of PlanAPIUser as per current implementation.

Returns:
integer ID of user

getOnBehalfOfUserID

int getOnBehalfOfUserID()
This method provides ID of the user who has initiated the procedure execution in a triggered environment.

Returns:
integer ID of user

isTriggerContext

boolean isTriggerContext()
This method notifies user if this invocation is initiated by a trigger or external API call over web-service.

Returns:
boolean variable to identify mode of invocation

getTriggerEvent

TriggerEventTypeEnum getTriggerEvent()
This method provides a triggered procedure with the Event that caused the trigger Returns null if not fired from a trigger

Returns:
event

getTriggerHandle

Handle getTriggerHandle()
This method provides a triggered procedure with the object that caused the trigger Returns null if not fired from a trigger

Returns:
handle

acquireLock

void acquireLock(Handle handle,
                 java.lang.String name)
                 throws LockInUseException,
                        InvalidLockException,
                        InvalidHandleException
Deprecated. use acquireLock(Handle handle) instead.

This method is deprecated and is internally calling acquireLock(Handle handle) method. The parameter name is ignored.

Parameters:
handle -
name -
Throws:
LockInUseException
InvalidLockException
InvalidHandleException

acquireLock

void acquireLock(Handle handle)
                 throws LockInUseException,
                        InvalidLockException,
                        InvalidHandleException
This method replaces acquireLock(Handle handle, String name) method

Parameters:
handle -
Throws:
LockInUseException
InvalidLockException
InvalidHandleException

releaseLock

void releaseLock(Handle handle,
                 java.lang.String name)
                 throws InvalidLockException,
                        InvalidHandleException
Deprecated. use releaseLock(Handle handle) instead.

This method is deprecated and is internally calling releaseLock(Handle handle) method. The parameter name is ignored.

Parameters:
handle -
name -
Throws:
InvalidLockException
InvalidHandleException

releaseLock

void releaseLock(Handle handle)
                 throws InvalidLockException,
                        InvalidHandleException
This method replaces releaseLock(Handle handle, String name) method

Parameters:
handle -
Throws:
InvalidLockException
InvalidHandleException

releaseAllLocks

void releaseAllLocks()

logInfo

void logInfo(java.lang.String message)

logWarning

void logWarning(java.lang.String message)

logWarning

void logWarning(java.lang.String message,
                java.lang.Exception exception)

logError

void logError(java.lang.String message)

logError

void logError(java.lang.String message,
              java.lang.Exception exception)