com.brightech.mb.workflow.js

Class JSSearchManager

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

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 JSSearchManager
extends JSBaseScriptableObject

Provides access to a search manager for javascript objects Is available in workflow context pre-initialized as "searchManager"

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

Method Summary

Modifier and Type	Method and Description
void	(JavaScript Function) delete(int theId) Deletes the specified search.
SolrConfigWrapper	(JavaScript Function) getR3SearchConfig(java.lang.String theWidgetId) Get r3search config from a widget id for a widget on some workspace.
SearchWrapper	(JavaScript Function) getSearch(int theSearchId) Get a saved search object by id number.
SearchWrapper	(JavaScript Function) getSearchByName(java.lang.String theName) Get a saved search object by name.
int	(JavaScript Function) save(SearchWrapper theSearch, User theUser) Saves the given GWTSearchVO and returns its id.
void	(JavaScript Function) searchByResolverUrl(java.lang.String theResolverUrl, int theUserId, org.mozilla.javascript.Function theCallback) Given a Resolver URL and a User ID, this will iterate through that set of assets, and call theCallback with a ManagedFile for each one.
void	(JavaScript Function) update(SearchWrapper theSearch, User theUser) Update the given GWTSearchVO
JSMap	(JavaScript Getter) conditions()
JSMap	(JavaScript Getter) conjunctions()
JSMap	(JavaScript Getter) sortOrderings() Get an array of valid sort orderings

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, 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, 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

JSSearchManager

public JSSearchManager()

Method Detail

(JavaScript Getter) conjunctions

public JSMap (JavaScript Getter) conjunctions()

(JavaScript Getter) conditions

public JSMap (JavaScript Getter) conditions()

(JavaScript Getter) sortOrderings

public JSMap (JavaScript Getter) sortOrderings()

Get an array of valid sort orderings

Returns:

The valid sort orderings

(JavaScript Function) searchByResolverUrl

public void (JavaScript Function) searchByResolverUrl(java.lang.String theResolverUrl,
                                           int theUserId,
                                           org.mozilla.javascript.Function theCallback)
                                    throws IterationException

Given a Resolver URL and a User ID, this will iterate through that set of assets, and call theCallback with a ManagedFile for each one.

Parameters:

theResolverUrl - A Resolver URL string.

theUserId - The Resolver URL will be evaluated in the context of the User having this ID. (In the case of selections, etc.)

theCallback - A JavaScript Function which will be called with a ManagedFile for each asset in the Resolver URL.

Throws:

IterationException

See Also:

ManagedFile

(JavaScript Function) getSearch

public SearchWrapper (JavaScript Function) getSearch(int theSearchId)
                                   throws SearchErrorException

Get a saved search object by id number. Note this is search id, not mediabeacon asset id.

Parameters:

theSearchId - The search id to look up

Returns:

The search object corresponding to the supplied id number.

Throws:

SearchErrorException

(JavaScript Function) getSearchByName

public SearchWrapper (JavaScript Function) getSearchByName(java.lang.String theName)
                                         throws SearchErrorException

Get a saved search object by name.

Parameters:

theName - The search name to look up

Returns:

The search object corresponding to the supplied name

Throws:

SearchErrorException - if an error occurs (usually there's more than 1 search with that name)

(JavaScript Function) update

public void (JavaScript Function) update(SearchWrapper theSearch,
                              User theUser)
                       throws NotLoggedInException

Update the given GWTSearchVO

Parameters:

theSearch - the search to update

Throws:

NotLoggedInException - not logged in

(JavaScript Function) save

public int (JavaScript Function) save(SearchWrapper theSearch,
                           User theUser)
                    throws NotLoggedInException

Saves the given GWTSearchVO and returns its id.

Parameters:

theSearch - the search to save

Returns:

the search id

Throws:

NotLoggedInException - not logged in

(JavaScript Function) delete

public void (JavaScript Function) delete(int theId)
                       throws NotLoggedInException

Deletes the specified search.

Parameters:

theId - the search id

Throws:

NotLoggedInException - not logged in

(JavaScript Function) getR3SearchConfig

public SolrConfigWrapper (JavaScript Function) getR3SearchConfig(java.lang.String theWidgetId)
                                               throws SearchException

Get r3search config from a widget id for a widget on some workspace.

Parameters:

theWidgetId - the widget id to get the config from

Returns:

SolrConfigWrapper object with the widget's config

Throws:

SearchException