public class SearchWrapper extends JSBaseScriptableObject implements org.mozilla.javascript.Wrapper
Constructor and Description |
---|
SearchWrapper()
Zero-arg constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
jsConstructor() |
void |
jsFunction_createQuickSearch(java.lang.String theSearch)
Deprecated.
|
void |
jsFunction_execute(org.mozilla.javascript.Function theCallback,
int thePageNumber,
int thePageSize)
Execute this search, running the supplied callback after execution completes.
|
ManagedFile[] |
jsFunction_executeForArray(int thePageNumber,
int thePageSize)
Execute this search
|
CriteriaWrapper |
jsFunction_getCriteria()
Get the current criteria for this search.
|
java.lang.String |
jsFunction_getDescription()
Get the search description
|
FacetListWrapper |
jsFunction_getFacets(SolrConfigWrapper theSolrConfig)
Get facets for a particular search.
|
int |
jsFunction_getID()
Get the search ID
|
boolean |
jsFunction_getIgnoreAcl()
Returns
true if the search will ignore the ACL and any mandatory search there |
java.lang.String |
jsFunction_getMetricsGraph(java.lang.String theSparklineField,
java.lang.String theLabel)
Execute this search, returning the JSON of the metrics graph.
|
java.lang.String |
jsFunction_getName()
Get the name of the search
|
int |
jsFunction_getSearchCount()
Get the number of results from this search
|
java.lang.String |
jsFunction_getSortDirection()
Get this search object's sort order.
|
java.lang.String |
jsFunction_getSortField()
Get this search object's sort field.
|
FacetWrapper |
jsFunction_getTermsWithLimit(SolrConfigWrapper theSolrConfig,
int thePageNumber,
int thePageSize)
Gets terms (with count of number of assets containing the given term) for a given metadata field.
|
boolean |
jsFunction_isPublic()
Get if the search is public
|
boolean |
jsFunction_isSendEmail()
Should an email be sent when the search is created?
|
void |
jsFunction_setCriteria(CriteriaWrapper theCriteria)
Set the criteria for this search.
|
void |
jsFunction_setDescription(java.lang.String theDescription)
Set the search description
|
void |
jsFunction_setIgnoreAcl(boolean theIgnoreAcl)
Set if the search should ignore the ACL and any root path or mandatory search there
|
void |
jsFunction_setMetrics(boolean theIsMetrics)
Sets if search should use metrics solr index.
|
void |
jsFunction_setName(java.lang.String theName)
Set the name of the search
|
void |
jsFunction_setPublic(boolean thePublic)
Set if the search is public
|
void |
jsFunction_setSendEmail(boolean theSendEmail)
Should an email be sent when the search is created?
|
void |
jsFunction_setSortDirection(java.lang.String theSortDirection)
Set sort direction.
|
void |
jsFunction_setSortField(java.lang.String theSortField)
Set sort field.
|
void |
jsFunction_waitForSolrIndexingResult()
Deprecated.
|
boolean |
jsGet_shouldRethrowOnFailedSearch() |
void |
jsSet_shouldRethrowOnFailedSearch(boolean theShouldRethrowOnFailedSearch) |
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
public void jsConstructor()
@Deprecated public void jsFunction_createQuickSearch(java.lang.String theSearch)
theSearch
- JSSearchManager.jsFunction_createQuickSearch(String)
public CriteriaWrapper jsFunction_getCriteria()
public void jsFunction_setCriteria(CriteriaWrapper theCriteria)
theCriteria
- The search criteria to set.public java.lang.String jsFunction_getName()
public void jsFunction_setName(java.lang.String theName)
theName
- the search namepublic int jsFunction_getID()
public java.lang.String jsFunction_getDescription()
public void jsFunction_setDescription(java.lang.String theDescription)
theDescription
- the search descripitonpublic boolean jsFunction_isSendEmail()
true
to send email, false
otherwisepublic void jsFunction_setSendEmail(boolean theSendEmail)
theSendEmail
- true
to send email, false
otherwisepublic void jsFunction_setPublic(boolean thePublic)
thePublic
- true
for a public search, false
for a private searchpublic void jsFunction_setIgnoreAcl(boolean theIgnoreAcl)
theIgnoreAcl
- true
to ignore ACL, false
(default) to use ACLpublic boolean jsFunction_getIgnoreAcl()
true
if the search will ignore the ACL and any mandatory search therepublic void jsFunction_setMetrics(boolean theIsMetrics)
theIsMetrics
- is metrics?public boolean jsFunction_isPublic()
true
for a public search, false
for a private searchpublic void jsFunction_setSortField(java.lang.String theSortField)
theSortField
- The field to order bypublic java.lang.String jsFunction_getSortField()
public void jsFunction_setSortDirection(java.lang.String theSortDirection) throws com.brightech.mb.web.search.SearchException
theSortDirection
- The order to sort results in.com.brightech.mb.web.search.SearchException
public java.lang.String jsFunction_getSortDirection()
public void jsFunction_execute(org.mozilla.javascript.Function theCallback, int thePageNumber, int thePageSize) throws jb.gwt_main_modules.base_widgets.client.exceptions.IterationException, com.brightech.mb.web.search.SearchException, java.lang.Exception
thePageNumber
- The page number to start returning results from.thePageSize
- The number of items per page desired.jb.gwt_main_modules.base_widgets.client.exceptions.IterationException
- If an error is encountered during execution of the search.com.brightech.mb.web.search.SearchException
- If the search is empty or the supplied criteria don't apply to the field.
E.g. "begins with" doesn't really apply to a date field.java.lang.Exception
public boolean jsGet_shouldRethrowOnFailedSearch()
public void jsSet_shouldRethrowOnFailedSearch(boolean theShouldRethrowOnFailedSearch)
public ManagedFile[] jsFunction_executeForArray(int thePageNumber, int thePageSize) throws java.lang.Exception
thePageNumber
- The page number to start returning results from.thePageSize
- The number of items per page desired.java.lang.Exception
- If an error is encountered during execution of the search.public int jsFunction_getSearchCount() throws com.brightech.mb.web.search.SearchException
com.brightech.mb.web.search.SearchException
public java.lang.String jsFunction_getMetricsGraph(java.lang.String theSparklineField, java.lang.String theLabel) throws jb.gwt_main_modules.base_widgets.client.exceptions.IterationException, com.brightech.mb.web.search.SearchException
com.brightech.mb.web.search.SearchException
- If the search is empty or the supplied criteria don't apply to the field.
E.g. "begins with" doesn't really apply to a date field.jb.gwt_main_modules.base_widgets.client.exceptions.IterationException
@Deprecated public void jsFunction_waitForSolrIndexingResult() throws java.lang.InterruptedException
java.lang.InterruptedException
- Thrown if this method is interrupted. Workflows should rethrow this exception
if they catch it to ensure that interrupted workflows terminate properly.Perform this search with the solr search engine until we get a result (or timeout). Useful for determining
if indexing has completed for a particular search.
public FacetListWrapper jsFunction_getFacets(SolrConfigWrapper theSolrConfig) throws com.brightech.mb.web.search.SearchException
theSolrConfig
- r3search config to get facets forcom.brightech.mb.web.search.SearchException
JSSearchManager.jsFunction_getR3SearchConfig(java.lang.String)
public FacetWrapper jsFunction_getTermsWithLimit(SolrConfigWrapper theSolrConfig, int thePageNumber, int thePageSize)
theSolrConfig
- the solr configurationthePageNumber
- the page numberthePageSize
- the page sizeCopyright © 2023 MediaBeacon, Inc. All Rights Reserved.