com.brightech.mb.workflow.js.event

Class TriggerEvent

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.event.TriggerEvent

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable

Direct Known Subclasses:

AssetBasedTriggerEvent, UserTriggeredTriggerEvent, WorkflowTriggerEvent

public class TriggerEvent
extends JSBaseScriptableObject

Base class for trigger events. If this event originated from user session, this event makes that session's user, group and ACL available to javascript. Each workflow has an instance of this class located at the "context" object in the workflow. This is the most basic type of event with no specifics on how it was triggered. The object at "context" will be one of the subclass types of this class

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class com.brightech.xmp.js.ReleasableScriptableObject

myLogger

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
TriggerEvent() Constructor (no-arg version for rhino).
TriggerEvent(int theType) Primary Constructor.

Method Summary

Modifier and Type	Method and Description
ACL	jsFunction_getACL() Get the ACL in use when the action was taken that triggered this event.
java.lang.String	jsFunction_getBaseUrl() returns the url ex.
TriggerConfiguration	jsFunction_getConfiguration() Returns the configuration for the workflow trigger.
org.mozilla.javascript.IdScriptableObject	jsFunction_getDate() Gets the trigger event date.
Group	jsFunction_getGroup() Get the group whose ACL was in use when the action was taken that triggered this event.
java.lang.Object	jsFunction_getParameter(java.lang.Object theParameterName, java.lang.Object theDefaultValue) Returns the value for the specified parameter name, or the given default value if there is no parameter with that name.
org.mozilla.javascript.NativeArray	jsFunction_getParameterNames() Returns an array of the parameter names.
java.util.Collection	jsFunction_getResponseHeaders() Gets the response header names.
java.lang.String	jsFunction_getResponseHeaderValue(java.lang.String theHeader) Gets the response header value that was previously set.
java.lang.String	jsFunction_getServerURL() returns the URL of the Mediabeacon server
java.lang.String	jsFunction_getSourceURL() returns the URL that called the WF if applicable
int	jsFunction_getType() Gets the event's trigger type.
java.lang.String	jsFunction_getTypeString() Returns the type string associated with this event's type.
java.lang.Object	jsFunction_getUploadedFile() Get the unmanaged instance of the file uploaded via POST request.
User	jsFunction_getUser() Returns the user whose action triggered this event.
Workflow	jsFunction_getWorkflow() Returns the event workflow file.
java.lang.String	jsFunction_setResponseHeader(java.lang.String theHeader, java.lang.String theValue) Sets the response header to the value.
java.lang.Object	jsFunction_toNative(java.lang.Object theObject) Returns a mock-up of the object as a native object so you can stringify it and see its attributes
org.mozilla.javascript.IdScriptableObject	jsGet_date() Deprecated. Use TriggerEvent.jsFunction_getDate() instead.
int	jsGet_type() Deprecated. Use TriggerEvent.jsFunction_getType() instead;

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

TriggerEvent

public TriggerEvent(int theType)

Primary Constructor.

Parameters:

theType - the event's trigger type

See Also:

TriggerConstants

TriggerEvent

public TriggerEvent()

Constructor (no-arg version for rhino).

Method Detail

jsFunction_getUploadedFile

public java.lang.Object jsFunction_getUploadedFile()

Get the unmanaged instance of the file uploaded via POST request. The file should have the parameter name 'file' in the POST request

Returns:

unmanaged temporary file

jsGet_date

@Deprecated
public org.mozilla.javascript.IdScriptableObject jsGet_date()

Deprecated. Use TriggerEvent.jsFunction_getDate() instead.

Gets the trigger event date.

Returns:

the event date, in a NativeDate object.

See Also:

TriggerEvent.jsFunction_getDate()

jsFunction_getDate

public org.mozilla.javascript.IdScriptableObject jsFunction_getDate()

Gets the trigger event date.

Returns:

the event date, in a NativeDate object.

jsGet_type

@Deprecated
public int jsGet_type()

Deprecated. Use TriggerEvent.jsFunction_getType() instead;

Gets the event's trigger type. One of:

ASSET_ADDED (int value: 1) ASSET_REMOVED (int value: 2) ASSET_MODIFIED (int value: 3) SCHEDULED (int value: 4) USER_TRIGGERED (int value: 5) PERMISSION (int value: 6) WORKFLOW_TRIGGERED (int value: 7)

Returns:

the event's trigger type

See Also:

TriggerEvent.jsFunction_getType()

jsFunction_getType

public int jsFunction_getType()

Gets the event's trigger type. One of:

ASSET_ADDED (int value: 1) ASSET_REMOVED (int value: 2) ASSET_MODIFIED (int value: 3) SCHEDULED (int value: 4) USER_TRIGGERED (int value: 5) PERMISSION (int value: 6) WORKFLOW_TRIGGERED (int value: 7)