public class Workflow extends ManagedFile
Modifier and Type | Class and Description |
---|---|
static class |
Workflow.ScheduleData
The workflow schedule data.
|
Modifier and Type | Field and Description |
---|---|
static int |
kDefaultTimeout
default timeout in seconds
|
static java.lang.String |
kPropertiesPrefix |
static java.lang.String |
kWorkflowClassName
The default class name.
|
static java.lang.String |
kWorkflowFileExtension
The workflow file extension.
|
static com.brightech.xmp.SchemaDefinition |
kWorkflowSchema
Workflow schema.
|
myAssetId
myBufferedReader, myBufferedWriter, myErrorMessage, myFile, myFileOutputStream, myXmp
CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST
kServerTypeAttribute
Constructor and Description |
---|
Workflow() |
Modifier and Type | Method and Description |
---|---|
void |
jsConstructor(java.lang.String theRelativePath)
Creates an object to access a workflow file.
|
TriggerConfiguration[] |
jsFunction_getConfiguredTriggers()
Returns the trigger configuration array, for Javascript.
|
java.lang.String |
jsFunction_getName()
Returns the workflow name (minus its ".xmpwf" file extension).
|
boolean |
jsFunction_isEnabled()
Returns true if this workflow is enabled, otherwise returns false.
|
void |
jsFunction_setEnabled(boolean theEnabled)
Sets the enable workflow flag.
|
java.lang.Object |
jsFunction_trigger(Parameters theParameters)
Triggers this workflow (as workflow-triggered) with specified parameters.
|
void |
jsFunction_triggerAsync(Parameters theParameters)
Triggers this workflow (as workflow-triggered) with specified parameters.
|
java.lang.Object |
jsFunction_triggerWithEvent(TriggerEvent theTriggerEvent)
Triggers this workflow for the specified trigger event context.
|
void |
jsFunction_triggerWithEventAsync(TriggerEvent theTriggerEvent)
Triggers this workflow for the specified trigger event context.
|
void |
jsFunction_triggerWithEventDelayed(TriggerEvent theTriggerEvent,
int theDelay,
Parameters theParameters)
Triggers this workflow with the specified trigger event context, running the workflow after the
specified delay and with the specified context and parameters.
|
Xmp |
jsGet_xmp()
Gets XMP object.
|
jsFunction_applyStampXml, jsFunction_getAbsolutePath, jsFunction_getBufferedReader, jsFunction_getBufferedWriter, jsFunction_getDatabaseField, jsFunction_getFileOutputStream, jsFunction_getFormattedSize, jsFunction_getImageURL, jsFunction_getMetricsData, jsFunction_isXmpModified, jsFunction_lock, jsFunction_normalizeXmp, jsFunction_releaseXmp, jsFunction_toString, jsFunction_unlock, jsFunction_writeXmp, jsGet_assetId, jsGet_base64, jsGet_colorprofile, jsGet_colorspace, jsGet_encodedAssetId, jsGet_errorMessage, jsGet_exists, jsGet_file, jsGet_fileNameExtension, jsGet_fileSizeIncludingMetadata, jsGet_format, jsGet_getFileContents, jsGet_getXmlFileContents, jsGet_height, jsGet_lastModified, jsGet_length, jsGet_name, jsGet_parent, jsGet_path, jsGet_rawLength, jsGet_record_id, jsGet_resolution, jsGet_width, jsSet_xmp
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, 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, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, 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, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String kWorkflowClassName
public static final com.brightech.xmp.SchemaDefinition kWorkflowSchema
public static final int kDefaultTimeout
public static final java.lang.String kWorkflowFileExtension
public static java.lang.String kPropertiesPrefix
public void jsConstructor(java.lang.String theRelativePath) throws InvalidManagedFilePathException
jsConstructor
in class ManagedFile
theRelativePath
- the relative path to the workflowInvalidManagedFilePathException
- if the file is not found or isn't a workflow.public Xmp jsGet_xmp()
jsGet_xmp
in interface IFileObject
jsGet_xmp
in class ManagedFile
Xmp
public void jsFunction_setEnabled(boolean theEnabled)
theEnabled
- is the workflow enabled to run?public boolean jsFunction_isEnabled()
public java.lang.String jsFunction_getName()
public TriggerConfiguration[] jsFunction_getConfiguredTriggers()
public java.lang.Object jsFunction_trigger(Parameters theParameters) throws java.lang.IllegalStateException
theParameters
- the parametersjava.lang.IllegalStateException
- if the workflow cannot be executedpublic void jsFunction_triggerAsync(Parameters theParameters) throws java.lang.IllegalStateException
theParameters
- the parametersjava.lang.IllegalStateException
- if the workflow cannot be executedpublic java.lang.Object jsFunction_triggerWithEvent(TriggerEvent theTriggerEvent) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
theTriggerEvent
- the trigger event context.java.lang.IllegalStateException
- if the workflow cannot be executedjava.lang.UnsupportedOperationException
- if the workflow cannot be executed for the specified trigger eventpublic void jsFunction_triggerWithEventAsync(TriggerEvent theTriggerEvent) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
theTriggerEvent
- the trigger event context.java.lang.IllegalStateException
- if the workflow cannot be executedjava.lang.UnsupportedOperationException
- if the workflow cannot be executed for the specified trigger eventpublic void jsFunction_triggerWithEventDelayed(TriggerEvent theTriggerEvent, int theDelay, Parameters theParameters) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
theTriggerEvent
- the trigger event context.theDelay
- the number of seconds to wait before executing the workflow.theParameters
- the parameters to execute with. (Can be null.)java.lang.IllegalStateException
- if the workflow cannot be executedjava.lang.UnsupportedOperationException
- if the workflow cannot be executed for the specified trigger eventJSWorkflowManager.jsFunction_sleep(int)
Copyright © 2023 MediaBeacon, Inc. All Rights Reserved.