com.brightech.mb.workflow.js.event

Class AssetBasedTriggerEvent

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

com.brightech.mb.workflow.js.event.AssetBasedTriggerEvent

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:

AssetAddedTriggerEvent, AssetCheckinTriggerEvent, AssetCopiedTriggerEvent, AssetDownloadedTriggerEvent, AssetModifiedTriggerEvent, AssetMovedTriggerEvent, AssetRemovedTriggerEvent, AssetRenamedTriggerEvent, PermissionTriggerEvent, ScheduledTriggerEvent

public class AssetBasedTriggerEvent
extends TriggerEvent

Base class for asset-based trigger events. Adds information about the particular asset the workflow was run against.

See Also:

TriggerEvent, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetBasedTriggerEvent.ActionType Actions that initiate asset-based triggers.

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

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kAssetActionTypeParameterKey Parameter key for asset-added action type.

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
AssetBasedTriggerEvent() Constructor.
AssetBasedTriggerEvent(int theTriggerType) Constructor.

Method Summary

Modifier and Type	Method and Description
int	jsFunction_getActionType() Gets the action type that added the asset.
java.lang.String	jsFunction_getActionTypeString() Returns the string associated with the asset-based action type.
IFileObject	jsFunction_getAsset() Returns the asset.
org.mozilla.javascript.NativeArray	jsFunction_getModifiedFields() Returns an array of modified metadata fields.
java.lang.Object	jsFunction_getNewFieldValue(PropertyWrapper theField) Returns the field's new value.
java.lang.Object	jsFunction_getOldFieldValue(PropertyWrapper theField) Returns the field's new value.
void	jsFunction_setAsset(IFileObject theAsset)
boolean	jsFunction_wasFieldModified(PropertyWrapper theField) Returns true if the field was changed as part of this asset modified event.

Methods inherited from class com.brightech.mb.workflow.js.event.TriggerEvent

jsFunction_getACL, jsFunction_getBaseUrl, jsFunction_getConfiguration, jsFunction_getDate, jsFunction_getGroup, jsFunction_getParameter, jsFunction_getParameterNames, jsFunction_getResponseHeaders, jsFunction_getResponseHeaderValue, jsFunction_getServerURL, jsFunction_getSourceURL, jsFunction_getType, jsFunction_getTypeString, jsFunction_getUploadedFile, jsFunction_getUser, jsFunction_getWorkflow, jsFunction_setResponseHeader, jsFunction_toNative, jsGet_date, jsGet_type

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

Field Detail

kAssetActionTypeParameterKey

public static final java.lang.String kAssetActionTypeParameterKey

Parameter key for asset-added action type.

See Also:

Constant Field Values

Constructor Detail

AssetBasedTriggerEvent

public AssetBasedTriggerEvent()

Constructor.

AssetBasedTriggerEvent

public AssetBasedTriggerEvent(int theTriggerType)

Constructor.

Parameters:

theTriggerType -

See Also:

TriggerConstants

Method Detail

jsFunction_setAsset

public void jsFunction_setAsset(IFileObject theAsset)

jsFunction_getActionType

public int jsFunction_getActionType()

Gets the action type that added the asset.

Returns:

the asset-based action type, as an integer (ordinal).

See Also:

AssetBasedTriggerEvent.ActionType

jsFunction_getActionTypeString

public java.lang.String jsFunction_getActionTypeString()

Returns the string associated with the asset-based action type.

Returns:

the action type string

See Also:

AssetBasedTriggerEvent.ActionType

jsFunction_getAsset

public IFileObject jsFunction_getAsset()

Returns the asset.

Returns:

IFileObject Either a ManagedFile object, if the event is not "AssetRemoved", or a File object otherwise.

jsFunction_wasFieldModified

public boolean jsFunction_wasFieldModified(PropertyWrapper theField)

Returns true if the field was changed as part of this asset modified event.

Parameters:

theField - the field

Returns:

boolean

jsFunction_getModifiedFields

public org.mozilla.javascript.NativeArray jsFunction_getModifiedFields()

Returns an array of modified metadata fields.

Returns:

array of fields (PropertyWrappers)

jsFunction_getNewFieldValue

public java.lang.Object jsFunction_getNewFieldValue(PropertyWrapper theField)

Returns the field's new value. Returns null if the field was not changed.

Parameters:

theField - the field

Returns:

the new value

jsFunction_getOldFieldValue

public java.lang.Object jsFunction_getOldFieldValue(PropertyWrapper theField)

Returns the field's new value. Returns null if the field was not changed.

Parameters:

theField - the field

Returns:

the old value