com.brightech.mb.workflow.js

Class Workspace

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

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

public class Workspace
extends JSBaseScriptableObject

A Javascript object representing a Workspace.

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

Method Summary

Modifier and Type	Method and Description
void	jsFunction_addWidget(com.brightech.mb.workflow.js.widget.JSWidget theWidget, java.lang.String theWidgetLayoutArea, int thePosition) Add the given widget to this workspace.
java.lang.String	jsFunction_getId() Get this workspace's id.
java.lang.String	jsFunction_getWidgetLayoutArea(com.brightech.mb.workflow.js.widget.JSWidget theWidget) Get which of the workspace's layout area the given widget is within.
java.lang.String[]	jsFunction_getWidgetLayoutAreas() Get the names of this workspace's widget layout areas.
com.brightech.mb.workflow.js.widget.JSWidget[]	jsFunction_getWidgets(java.lang.String theWidgetLayoutArea) Get this workspace's widgets.
boolean	jsFunction_hasRequiredUploadM3taforms() Does this workflow have required upload M3taforms?
org.mozilla.javascript.Scriptable	jsFunction_initializeRequiredM3taformUpload(User theUser, ACL theACL, int theTotalUploads, java.lang.String theCustomLogAction, ManagedFolder theUploadDir, boolean theUnpack) Initialize a required M3taform upload to this workspace by the given user.
int	jsFunction_removeWidget(com.brightech.mb.workflow.js.widget.JSWidget theWidget) Remove the given widget from the workspace.
void	jsFunction_write() Write this workspace's config back to the database.

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

Workspace

public Workspace()

Method Detail

jsFunction_getId

public java.lang.String jsFunction_getId()

Get this workspace's id.

Returns:

This workspace's id.

jsFunction_getWidgets

public com.brightech.mb.workflow.js.widget.JSWidget[] jsFunction_getWidgets(java.lang.String theWidgetLayoutArea)

Get this workspace's widgets.

Parameters:

theWidgetLayoutArea - Optional, if null all of this workspace's widgets will be returned, if not null only the widgets from the give layout area will be returned.

Returns:

This workspace's widgets.

jsFunction_removeWidget

public int jsFunction_removeWidget(com.brightech.mb.workflow.js.widget.JSWidget theWidget)

Remove the given widget from the workspace. If the given widget is already not used by this workspace, this function has no effect.

Parameters:

theWidget - the Widget to remove.

Returns:

the position of removed widget

jsFunction_addWidget

public void jsFunction_addWidget(com.brightech.mb.workflow.js.widget.JSWidget theWidget,
                                 java.lang.String theWidgetLayoutArea,
                                 int thePosition)

Add the given widget to this workspace.

Parameters:

theWidget - The widget to add.

theWidgetLayoutArea - The layout area of the workspace to add the widget to.

thePosition - The position in the workspace layout area to add the widget to. If less than 0, the widget is added to the end of the area.

jsFunction_getWidgetLayoutArea

public java.lang.String jsFunction_getWidgetLayoutArea(com.brightech.mb.workflow.js.widget.JSWidget theWidget)

Get which of the workspace's layout area the given widget is within. Returns null if the given widget is not used by this workspace.

Parameters:

theWidget - The widget.

Returns:

Which of the workspace's layout area the given widget is within. Returns null if the given widget is not used by this workspace.

jsFunction_getWidgetLayoutAreas

public java.lang.String[] jsFunction_getWidgetLayoutAreas()

Get the names of this workspace's widget layout areas.

Returns:

The names of this workspace's widget layout areas.

jsFunction_write

public void jsFunction_write()

Write this workspace's config back to the database.

jsFunction_hasRequiredUploadM3taforms

public boolean jsFunction_hasRequiredUploadM3taforms()

Does this workflow have required upload M3taforms?

Returns:

Does this workflow have required upload M3taforms?

jsFunction_initializeRequiredM3taformUpload

public org.mozilla.javascript.Scriptable jsFunction_initializeRequiredM3taformUpload(User theUser,
                                                                                     ACL theACL,
                                                                                     int theTotalUploads,
                                                                                     java.lang.String theCustomLogAction,
                                                                                     ManagedFolder theUploadDir,
                                                                                     boolean theUnpack)

Initialize a required M3taform upload to this workspace by the given user.

Parameters:

theUser - The uploading users.

theACL - The ACL being used.

theTotalUploads - The total number of items (files, folders, archives) that are being uploaded

theCustomLogAction - Optional custom action to log the upload with.

theUploadDir - Optional, defines the path the files should be uploaded to, if null the files will be

theUnpack - should archives be unpacked uploaded to the default location based on the given user and ACL.

Returns:

A javascript object with two properties: uploadDir : The temporary upload destination for the newly initialized required M3taform upload. uploadId : The id for the pending upload. finalUploadDir : The final destination for this upload.

Throws:

java.lang.IllegalArgumentException - If this workspace has no required upload M3taforms.