com.brightech.mb.workflow.js

Class JSWorkflowManager

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.JSWorkflowManager

All Implemented Interfaces:

com.brightech.utils.Metrics, 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

public class JSWorkflowManager
extends JSBaseScriptableObject
implements com.brightech.utils.Metrics

User: Nate Solas Date: 6/11/14 There are special cases that need to be able to trigger nested workflows: Aspera uploads, for instance, need to act like proper uploads and trigger Asset Added workflows. This special case is marked via a parameter that is removed if present so it doesn't carry through to the workflow. Only workflow triggers that check for this param can be overridden.

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 com.brightech.utils.Metrics

kDay, kDurationFormat, kGb, kHour, kHourDurationFormat, kKb, kMb, kMinute, kMinutesInHour, kSecond, kSecondInMinute, kWeek, kYear, kYearInSeconds

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSWorkflowManager()

Method Summary

Modifier and Type	Method and Description
boolean	jsFunction_isWorkflowRunning(java.lang.String theWorkflowName) Returns true if an instance of the workflow is running, otherwise returns false.
void	jsFunction_sleep(int theSeconds) Use this method to sleep a workflow, instead of polling the clock and thrashing the CPU.
ManagedFile	jsFunction_triggerAssetAdded(ManagedFile theAsset) Sets up the mock parameter as described above and triggers the workflow
ManagedFile	jsFunction_triggerAssetDownloaded(ManagedFile theAsset) Sets up the mock parameter as described above and triggers the workflow
ManagedFile	jsFunction_triggerAssetModified(ManagedFile theAsset, org.mozilla.javascript.NativeObject theModifiedFields) Triggers an "asset modified" event.
void	jsFunction_triggerAssetRemoved(ManagedFile theAsset) Sets up the mock parameter as described above and triggers the workflow

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

JSWorkflowManager

public JSWorkflowManager()

Method Detail

jsFunction_triggerAssetAdded

public ManagedFile jsFunction_triggerAssetAdded(ManagedFile theAsset)

Sets up the mock parameter as described above and triggers the workflow

Parameters:

theAsset - which asset are we "adding"

Returns:

the same file, for easy chaining.

jsFunction_triggerAssetRemoved

public void jsFunction_triggerAssetRemoved(ManagedFile theAsset)

Sets up the mock parameter as described above and triggers the workflow

Parameters:

theAsset - which asset are we "adding"

jsFunction_triggerAssetDownloaded

public ManagedFile jsFunction_triggerAssetDownloaded(ManagedFile theAsset)

Sets up the mock parameter as described above and triggers the workflow

Parameters:

theAsset - which asset are we "adding"

Returns:

the same file, for easy chaining.

jsFunction_triggerAssetModified

public ManagedFile jsFunction_triggerAssetModified(ManagedFile theAsset,
                                                   org.mozilla.javascript.NativeObject theModifiedFields)

Triggers an "asset modified" event. Allows for workflow chaining, but needs to be called manually.

Parameters:

theAsset - the asset we have modified along with the fields that were modified.

Returns:

the same file, for easy chaining.

jsFunction_sleep

public void jsFunction_sleep(int theSeconds)
                      throws java.lang.ThreadDeath

Use this method to sleep a workflow, instead of polling the clock and thrashing the CPU. If using sleep in an iteration, consider using Workflow.jsFunction_triggerWithEventDelayed() for efficiency.

Parameters:

theSeconds - the seconds to sleep

Throws:

java.lang.ThreadDeath - if this method (thread) is interrupted, or if the thread is already in an interrupted state. (Workflows cannot catch/swallow ThreadDeath errors.)

See Also:

Workflow.jsFunction_triggerWithEventDelayed(com.brightech.mb.workflow.js.event.TriggerEvent, int, com.brightech.mb.workflow.js.Parameters)

jsFunction_isWorkflowRunning

public boolean jsFunction_isWorkflowRunning(java.lang.String theWorkflowName)

Returns true if an instance of the workflow is running, otherwise returns false.

Parameters:

theWorkflowName - the workflow name.

Returns:

true if running, false if not.