jb.gwt_main_modules.base_widgets.client.js_api

Class SearchApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.SearchApiPublisher

public class SearchApiPublisher
extends java.lang.Object

Methods for creating and running searches in the user's interface.

All methods are located in a sub object at window.MBAPI.search

(window.MBAPI.search.getViewPage() for example)

Constructor Summary

Constructors

Constructor and Description
SearchApiPublisher()

Method Summary

Modifier and Type	Method and Description
static void	addResolverToBasket(java.lang.String theResolver, com.google.gwt.core.client.JavaScriptObject theCallback) Adds assets specified by the resolver to a basket.
static jb.gwt_main_modules.base_widgets.client.searches.GwtBooleanCriterion	createBooleanCriterion(java.lang.String theConjugation) Create a GwtSearchCriteria object for searching with
static jb.gwt_main_modules.base_widgets.client.searches.GwtCurrentSelectionSearchLocation	createCurrentSelectionSearch() Get a location object for displaying the current selection
static jb.gwt_main_modules.base_widgets.client.searches.GwtDirectoryCriterion	createDirectorySearch(int theDirectoryId, boolean theIsTransparent) Get a search object for directory search
static jb.gwt_main_modules.base_widgets.client.searches.GwtDirectoryCriterion	createDirectorySearchRelative(java.lang.String theDirectoryRelativePath, boolean theIsTransparent) Get a search object for directory search
static jb.gwt_main_modules.base_widgets.client.searches.GwtFieldCriterion	createFieldCriterion(java.lang.String theField, java.lang.String theCondition, java.lang.String theValue) Create a field criterion
static jb.gwt_main_modules.base_widgets.client.searches.GwtQuickSearchCriterion	createQuickSearch(java.lang.String theSearch, boolean theUseDictionaries, boolean theUseSynonyms, boolean theUseThesaurus) Get a search object for the "quick search" portion.
static jb.gwt_main_modules.base_widgets.client.searches.GwtSavedSelectionCriterion	createSavedSelectionSearch(int theSelectionId) Get a location object for displaying a saved selection
static com.google.gwt.core.client.JavaScriptObject	getNativeBooleanCriteria(jb.gwt_main_modules.base_widgets.client.searches.GwtBooleanCriterion theCriterion)
static void	getPlacedImages(int theAssetId, com.google.gwt.core.client.JavaScriptObject theCallback) Returns an array of record ids of places assets
static void	getSavedSearch(java.lang.String theSavedSearchName, com.google.gwt.core.client.JavaScriptObject theCallback) Method returns a saved search by name Example code: function doSearch() { parent.MBAPI.search.getSavedSearch("My Search Name", callback); } function callback(theSearch) { parent.MBAPI.search.getViewPage().setSearch(theSearch); parent.MBAPI.search.refreshView(function(){}); }
static void	getSavedSearchById(int theSavedSearchId, com.google.gwt.core.client.JavaScriptObject theCallback) Method returns a saved search by id Example code: function doSearch() { parent.MBAPI.search.getSavedSearchById(3, callback);//3 is the search id } function callback(theSearch) { parent.MBAPI.search.getViewPage().setSearch(theSearch); parent.MBAPI.search.refreshView(function(){}); }
static jb.gwt_main_modules.base_widgets.client.services.ViewPage	getViewPage() Gets an instance of our current ViewPage so we can modify and do searches
static void	hasVersions(int theRecordId, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Does this asset have any versions
static void	internalHasVersions(int theRecordId, com.google.gwt.core.client.JavaScriptObject theCallback)
static void	loadAllVersions(int theRecordId) Load all versions of this file into the user's current selection and show them in the active view widget
static void	refreshView(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Calling this method will reload our current ViewPage
static void	setSortOrder(java.lang.String theField) Sets the sort order for specified field.
static void	setupJavascriptAPIs()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchApiPublisher

public SearchApiPublisher()

Method Detail

setupJavascriptAPIs

public static void setupJavascriptAPIs()

getSavedSearch

public static void getSavedSearch(java.lang.String theSavedSearchName,
                                  com.google.gwt.core.client.JavaScriptObject theCallback)

Method returns a saved search by name Example code: function doSearch() { parent.MBAPI.search.getSavedSearch("My Search Name", callback); } function callback(theSearch) { parent.MBAPI.search.getViewPage().setSearch(theSearch); parent.MBAPI.search.refreshView(function(){}); }

Parameters:

theSavedSearchName - the saved search name

theCallback - callback function to pass the search to

getSavedSearchById

public static void getSavedSearchById(int theSavedSearchId,
                                      com.google.gwt.core.client.JavaScriptObject theCallback)

Method returns a saved search by id Example code: function doSearch() { parent.MBAPI.search.getSavedSearchById(3, callback);//3 is the search id } function callback(theSearch) { parent.MBAPI.search.getViewPage().setSearch(theSearch); parent.MBAPI.search.refreshView(function(){}); }

Parameters:

theSavedSearchId - the saved search id

theCallback - callback function to pass the search to

getNativeBooleanCriteria

public static com.google.gwt.core.client.JavaScriptObject getNativeBooleanCriteria(jb.gwt_main_modules.base_widgets.client.searches.GwtBooleanCriterion theCriterion)

createDirectorySearchRelative

public static jb.gwt_main_modules.base_widgets.client.searches.GwtDirectoryCriterion createDirectorySearchRelative(java.lang.String theDirectoryRelativePath,
                                                                                                                   boolean theIsTransparent)

Get a search object for directory search

Parameters:

theDirectoryRelativePath - the directory relative path

theIsTransparent - should we show files only in the current directory or assets in subdirectories as well

Returns:

GwtDirectorySearch location object

createDirectorySearch

public static jb.gwt_main_modules.base_widgets.client.searches.GwtDirectoryCriterion createDirectorySearch(int theDirectoryId,
                                                                                                           boolean theIsTransparent)

Get a search object for directory search

Parameters:

theDirectoryId - the directory id

theIsTransparent - should we show files only in the current directory or assets in subdirectories as well

Returns:

GwtDirectorySearch location object

createQuickSearch

public static jb.gwt_main_modules.base_widgets.client.searches.GwtQuickSearchCriterion createQuickSearch(java.lang.String theSearch,
                                                                                                         boolean theUseDictionaries,
                                                                                                         boolean theUseSynonyms,
                                                                                                         boolean theUseThesaurus)

Get a search object for the "quick search" portion. Of note: a "normal" quicksearch also includes a file_name search component that is not included here

Parameters:

theSearch - the search string

theUseDictionaries - use dictionaries in the search

theUseSynonyms - search for synonyms too

Returns:

quicksearch criterion for use with view page and searching
Note: To limit the results on only the specified fields use setFieldsToSearch method in createQuickSearch class.

Example code:

 
 var theSearch = 'This is a search string';
 var anSearchAPI = window.MBAPI.search;
 var aQuickSearch = anSearchAPI.createQuickSearch(theSearch, true, false, false);
 var theFieldsToSearch = ['http://sampleFields/ title', 'http://sampleFields/ keywords'];
 aQuickSearch.setFieldsToSearch(theFieldsToSearch) // Array containing the fields to search
 var aBooleanCriterion = anSearchAPI.createBooleanCriterion('AND');
 aBooleanCriterion.addCriterion(aQuickSearch);
 anSearchAPI.getViewPage().setSearch( aBooleanCriterion);
 anSearchAPI.refreshView(() => {
 });
 

createCurrentSelectionSearch

public static jb.gwt_main_modules.base_widgets.client.searches.GwtCurrentSelectionSearchLocation createCurrentSelectionSearch()

Get a location object for displaying the current selection

Returns:

GwtCurrentSelectionSearchLocation location object

createBooleanCriterion

public static jb.gwt_main_modules.base_widgets.client.searches.GwtBooleanCriterion createBooleanCriterion(java.lang.String theConjugation)

Create a GwtSearchCriteria object for searching with

Parameters:

theConjugation - AND or OR

Returns:

boolean criterion for use with view page and search

createFieldCriterion

public static jb.gwt_main_modules.base_widgets.client.searches.GwtFieldCriterion createFieldCriterion(java.lang.String theField,
                                                                                                      java.lang.String theCondition,
                                                                                                      java.lang.String theValue)

Create a field criterion

Parameters:

theField - the field id eg http://mediabeacon.com/work/1.0/ time

theCondition - the condition (3 is equals)

theValue - the value to search with

Returns:

field criterion for use with view page and search

createSavedSelectionSearch

public static jb.gwt_main_modules.base_widgets.client.searches.GwtSavedSelectionCriterion createSavedSelectionSearch(int theSelectionId)

Get a location object for displaying a saved selection

Parameters:

theSelectionId - the selection id to load

Returns:

GwtSavedSelectionCriterion location object

getViewPage

public static jb.gwt_main_modules.base_widgets.client.services.ViewPage getViewPage()

Gets an instance of our current ViewPage so we can modify and do searches

Returns:

the view page object the page uses to display assets

refreshView

public static void refreshView(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Calling this method will reload our current ViewPage

Parameters:

theCallback - function to inform when the viewpage is fetched and parsed from the server

loadAllVersions

public static void loadAllVersions(int theRecordId)

Load all versions of this file into the user's current selection and show them in the active view widget

Parameters:

theRecordId - the asset id to search with

internalHasVersions

public static void internalHasVersions(int theRecordId,
                                       com.google.gwt.core.client.JavaScriptObject theCallback)

hasVersions

public static void hasVersions(int theRecordId,
                               jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Does this asset have any versions

Parameters:

theRecordId - the asset to look for

theCallback - returns true if we have any of the version types

setSortOrder

public static void setSortOrder(java.lang.String theField)

Sets the sort order for specified field.

Parameters:

theField - the field to sort

getPlacedImages

public static void getPlacedImages(int theAssetId,
                                   com.google.gwt.core.client.JavaScriptObject theCallback)

Returns an array of record ids of places assets

Parameters:

theAssetId - INDD asset to search with

theCallback - callback function to inform when we have the information

addResolverToBasket

public static void addResolverToBasket(java.lang.String theResolver,
                                       com.google.gwt.core.client.JavaScriptObject theCallback)

Adds assets specified by the resolver to a basket.

Parameters:

theResolver - the resolver.

theCallback - the callback.