com.brightech.mb.workflow

Class Workflow

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

com.brightech.mb.workflow.Workflow

All Implemented Interfaces:

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

public class Workflow
extends ManagedFile

Workflow structure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Workflow.ScheduleData The workflow schedule data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kWorkflowClassName The default class name.
static java.lang.String	kWorkflowFileExtension The workflow file extension.
static SchemaDefinition	kWorkflowSchema Workflow schema.

Fields inherited from class com.brightech.mb.workflow.js.ManagedFile

kManagedFileClassName, kServerTypeAttribute

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
Workflow()

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theRelativePath) Creates an object to access a workflow file.
TriggerConfiguration[]	(JavaScript Function) getConfiguredTriggers() Get selected triggers configuration.
java.lang.String	(JavaScript Function) getName() Returns the workflow name (minus its ".xmpwf" file extension).
boolean	(JavaScript Function) isEnabled() Returns true if this workflow is enabled, otherwise returns false.
void	(JavaScript Function) setEnabled(boolean theEnabled) Sets the enable workflow flag.
java.lang.Object	(JavaScript Function) trigger(Parameters theParameters) Triggers this workflow (as workflow-triggered) with specified parameters.
void	(JavaScript Function) triggerAsync(Parameters theParameters) Triggers this workflow (as workflow-triggered) with specified parameters.
java.lang.Object	(JavaScript Function) triggerWithEvent(TriggerEvent theTriggerEvent) Triggers this workflow for the specified event.
void	(JavaScript Function) triggerWithEventAsync(TriggerEvent theTriggerEvent) Triggers this workflow for the specified event.
Xmp	(JavaScript Getter) xmp() Gets XMP object.

Methods inherited from class com.brightech.mb.workflow.js.ManagedFile

(JavaScript Function) applyStampXml, (JavaScript Function) getAbsolutePath, (JavaScript Function) getBufferedReader, (JavaScript Function) getBufferedWriter, (JavaScript Function) getFileOutputStream, (JavaScript Function) getFormattedSize, (JavaScript Function) getImageURL, (JavaScript Function) lock, (JavaScript Function) normalizeXmp, (JavaScript Function) releaseXmp, (JavaScript Function) unlock, (JavaScript Function) writeXmp, (JavaScript Getter) assetId, (JavaScript Getter) colorprofile, (JavaScript Getter) colorspace, (JavaScript Getter) encodedAssetId, (JavaScript Getter) exists, (JavaScript Getter) file, (JavaScript Getter) fileNameExtension, (JavaScript Getter) format, (JavaScript Getter) getFileContents, (JavaScript Getter) getXmlFileContents, (JavaScript Getter) height, (JavaScript Getter) lastModified, (JavaScript Getter) length, (JavaScript Getter) name, (JavaScript Getter) parent, (JavaScript Getter) path, (JavaScript Getter) rawLength, (JavaScript Getter) resolution, (JavaScript Getter) width, (JavaScript Setter) xmp

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

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

contextCreated, contextReleased

Field Detail

kWorkflowClassName

public static final java.lang.String kWorkflowClassName

The default class name.

See Also:

Constant Field Values

kWorkflowSchema

public static final SchemaDefinition kWorkflowSchema

Workflow schema.

kWorkflowFileExtension

public static final java.lang.String kWorkflowFileExtension

The workflow file extension.

See Also:

Constant Field Values

Constructor Detail

Workflow

public Workflow()

Method Detail

jsConstructor

public void jsConstructor(java.lang.String theRelativePath)
                   throws InvalidManagedFilePathException

Creates an object to access a workflow file.

Overrides:

jsConstructor in class ManagedFile

Parameters:

theRelativePath - the relative path to the workflow

Throws:

InvalidManagedFilePathException - if the file is not found or isn't a workflow.

(JavaScript Getter) xmp

public Xmp (JavaScript Getter) xmp()

Gets XMP object. Fetches XMP from the database if needed.

Specified by:

(JavaScript Getter) xmp in interface IFileObject

Overrides:

(JavaScript Getter) xmp in class ManagedFile

Returns:

XMP manipulation object

See Also:

Xmp

(JavaScript Function) setEnabled

public void (JavaScript Function) setEnabled(boolean theEnabled)

Sets the enable workflow flag.

Parameters:

theEnabled - is the workflow enabled to run?

(JavaScript Function) isEnabled

public boolean (JavaScript Function) isEnabled()

Returns true if this workflow is enabled, otherwise returns false.

Returns:

true if yet, false otherwise.

(JavaScript Function) getName

public java.lang.String (JavaScript Function) getName()

Returns the workflow name (minus its ".xmpwf" file extension).

Returns:

the name of the workflow.

(JavaScript Function) getConfiguredTriggers

public TriggerConfiguration[] (JavaScript Function) getConfiguredTriggers()

Get selected triggers configuration.

Returns:

the triggers configuration array.

(JavaScript Function) trigger

public java.lang.Object (JavaScript Function) trigger(Parameters theParameters)
                                    throws java.lang.IllegalStateException

Triggers this workflow (as workflow-triggered) with specified parameters. Runs the workflow synchronously and returns its result.

Parameters:

theParameters - the parameters

Returns:

the workflow result

Throws:

java.lang.IllegalStateException - if the workflow cannot be executed

(JavaScript Function) triggerAsync

public void (JavaScript Function) triggerAsync(Parameters theParameters)
                             throws java.lang.IllegalStateException

Triggers this workflow (as workflow-triggered) with specified parameters. Runs the workflow asynchronously (returns immediately with no result).

Parameters:

theParameters - the parameters

Throws:

java.lang.IllegalStateException - if the workflow cannot be executed

(JavaScript Function) triggerWithEvent

public java.lang.Object (JavaScript Function) triggerWithEvent(TriggerEvent theTriggerEvent)
                                             throws java.lang.IllegalStateException,
                                                    java.lang.UnsupportedOperationException

Triggers this workflow for the specified event. Runs the workflow synchronously and returns its result.

Parameters:

theTriggerEvent - the trigger event

Returns:

the workflow result (possibly null)

Throws:

java.lang.IllegalStateException - if the workflow cannot be executed

java.lang.UnsupportedOperationException - if the workflow cannot be executed for the specified trigger event

(JavaScript Function) triggerWithEventAsync

public void (JavaScript Function) triggerWithEventAsync(TriggerEvent theTriggerEvent)
                                      throws java.lang.IllegalStateException,
                                             java.lang.UnsupportedOperationException

Triggers this workflow for the specified event. Runs the workflow asynchronously (returns immediately with no result).

Parameters:

theTriggerEvent - the trigger event

Throws:

java.lang.IllegalStateException - if the workflow cannot be executed

java.lang.UnsupportedOperationException - if the workflow cannot be executed for the specified trigger event