com.brightech.mb.workflow.js

Class JSSavedSelectionManager

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

All Implemented Interfaces:

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

public class JSSavedSelectionManager
extends JSBaseScriptableObject

SavedSelectionManager for javascript. Is available in workflow context pre-initialized as "savedSelectionManager"

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	(JavaScript Function) clearCurrentSelection() Clears the current users selection
void	(JavaScript Function) deleteSelection(int theSelectionId) Deletes the specified selection.
int	(JavaScript Function) getCurrentSelectionCount() Returns the number of assets in the selection for the current users current s
SavedSelection[]	(JavaScript Function) getSavedSelectionsForUser(java.lang.String theUserName) Returns an Array of Saved Selections for a user with theUserName
SavedSelection	(JavaScript Function) getSelection(int theSelectionId) Returns the SavedSelection for the specified id.
SavedSelection	(JavaScript Function) saveSelection(java.lang.String theName, java.lang.String theDescription, boolean theIsPublic, boolean theModifiable, java.lang.String theResolverUrl) save a selection
void	(JavaScript Function) selectAll(CriteriaWrapper theCriteria) Selects all assets for the current user in the context of the given search criteria

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.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSSavedSelectionManager

public JSSavedSelectionManager()

Method Detail

(JavaScript Function) getSelection

public SavedSelection (JavaScript Function) getSelection(int theSelectionId)

Returns the SavedSelection for the specified id.

Parameters:

theSelectionId -

Returns:

the selection, or null if a selection doesn't exist for the specified id.

(JavaScript Function) saveSelection

public SavedSelection (JavaScript Function) saveSelection(java.lang.String theName,
                                               java.lang.String theDescription,
                                               boolean theIsPublic,
                                               boolean theModifiable,
                                               java.lang.String theResolverUrl)

save a selection

Parameters:

theName - name to save

theDescription - description to save

theIsPublic - is selection public

theModifiable - is selection modifiable

theResolverUrl - the url to define what assets to put in the selection

Returns:

SavedSelection object representing

(JavaScript Function) selectAll

public void (JavaScript Function) selectAll(CriteriaWrapper theCriteria)

Selects all assets for the current user in the context of the given search criteria

Parameters:

theCriteria - search for the selection. Accepts null to select everything

(JavaScript Function) getCurrentSelectionCount

public int (JavaScript Function) getCurrentSelectionCount()

Returns the number of assets in the selection for the current users current s

(JavaScript Function) clearCurrentSelection

public boolean (JavaScript Function) clearCurrentSelection()

Clears the current users selection

Returns:

false if failed to clear selection

(JavaScript Function) getSavedSelectionsForUser

public SavedSelection[] (JavaScript Function) getSavedSelectionsForUser(java.lang.String theUserName)

Returns an Array of Saved Selections for a user with theUserName

Parameters:

theUserName -

Returns:

SavedSelection Array

(JavaScript Function) deleteSelection

public void (JavaScript Function) deleteSelection(int theSelectionId)

Deletes the specified selection.

Parameters:

theSelectionId - the selection id of the selection to delete.