public interface

SearchBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.SearchBean

Class Overview

This bean is used to render and save the state of searches. It heavily relies on the FolderBean, so please make sure it has a FolderBean as a children.
It uses a SearchSimpleTransform to generate its output.
It handles it request by searching for the Folder Search Event, and if found it changes its state to the values in the request.

Summary

Constants
int DATE_ALL_DATES
int DATE_BETWEEN_DATES
int DATE_BETWEEN_INTERVAL
int DATE_CREATED
int DATE_DAYS
int DATE_HOURS
int DATE_MODIFIED
int DATE_MONTHS
int DATE_SPECIFIC_DATE
int DATE_WEEKS
int DATE_YEARS
String FIELD_DATE_CREATED
String FIELD_DATE_SUBTYPE
String FIELD_DATE_TYPE
String FIELD_DESCRIPTION
String FIELD_END_DATE
String FIELD_FOLDER_ID
String FIELD_FOLDER_TYPE
String FIELD_ID
String FIELD_INTERVAL_UNIT
String FIELD_INTERVAL_VALUE
String FIELD_NAME
String FIELD_OWNER_TYPE
String FIELD_SEARCH_OPTIONS
String FIELD_START_DATE
String FIELD_TYPES
String FIELD_WILDCARDS
int OWNER_ALL
int OWNER_CURRENT
String SEARCH_STR_MAX_SIZE
int WILDCARD_BEGINS
int WILDCARD_CONTAINS
int WILDCARD_CONTAINS_ANY
int WILDCARD_ENDS
int WILDCARD_EXACTLY
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getBlockCount()
abstract int getDateCreated()
Gets whether the search will be taken from the creation or modification time.
abstract int getDateSubType()
Gets whether the search will be restricted based on a time or date interval.
abstract int getDateType()
Gets whether the search will be restricted based on dates.
abstract String getDescriptionPattern()
Returns the description pattern that the search is currently limited to.
abstract int getDomain()
Return the search domain, an enumeration value from EnumDSSXMLSearchDomain.
abstract String getEndDate()
Gets the end date if the search is restricted on a date interval.
abstract FolderBean getFolderBean()
abstract String getFolderID()
Gets the folder ID where the user is coming from.
abstract String getFolderName()
Gets the folder name where the user is coming from.
abstract int getFolderType()
Gets the folder type, which specifies a system folder ID.
abstract int getIntervalUnit()
Gets the time units to use if the search is restricted on a time interval.
abstract String getIntervalValue()
Gets the time value to use if the search is restricted on a time interval.
abstract int getMaxWait()
abstract String getNamePattern()
Returns the pattern to search for in the name of the objects in metadata.
abstract int getOwnerType()
Gets the owner of the objects to search for.
abstract int getPollingFrequency()
abstract String getSearchID()
Returns the search ID of the last search submitted, or the last time setSearchID was called.
abstract String getStartDate()
Gets the start date if the search is restricted on a date interval.
abstract SimpleListObj getTypes()
Returns a SimpleListObj from which types can be added or removed.
abstract int getWildCards()
Returns the wild card used in the current search.
abstract boolean isAdvanced()
abstract boolean isDerefrenceShortcut()
Indicate whether DssXmlSearchDereferenceShortcut flag should be set for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }
abstract boolean isFieldValid(String field)
Checks if the field has valid information.
abstract void setAdvanced(boolean advanced)
Sets the bean to show in advaced/simple mode.
abstract void setBlockCount(int count)
Sets the Block count.
abstract void setDateCreated(int dateCreated)
Sets whether the search will be taken from the creation or modification time.
abstract void setDateSubType(int dateSubType)
Sets whether the search will be restricted based on a time or date interval.
abstract void setDateType(int dataType)
Sets whether the search will be restricted based on dates.
abstract void setDerefrenceShortcut(boolean derefrenceShortcut)
Set the DerefrenceShortcut property which indicate DssXmlSearchDereferenceShortcut flag for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }
abstract void setDescriptionPattern(String description)
Sets the description pattern that the search will be limited to.
abstract void setDomain(int domain)
Sets the search domain, an enumeration value from EnumDSSXMLSearchDomain.
abstract void setEndDate(String endDate)
Sets the end date of a search restricted on a date interval.
abstract void setFolderID(String id)
Sets the folderId.
abstract void setFolderType(int type)
Sets the folderType.
abstract void setIntervalUnit(int intervalUnit)
Sets the time units to use if the search is restricted on a time interval.
abstract void setIntervalValue(String intervalValue)
Sets the time value to use if the search is restricted on a time interval.
abstract void setMaxWait(int wait)
Sets the maximum time that a search will wait before returning.
abstract void setNamePattern(String name)
Sets the pattern to search for in the name of the objects in metadata.
abstract void setOwnerType(int ownerType)
Sets the owner of the objects to search for.
abstract void setPollingFrequency(int frequency)
Sets the time that a search will will poll for the results.
abstract void setSearchID(String id)
Sets the search ID.
abstract void setStartDate(String startDate)
Sets the start date of a search restricted on a date interval.
abstract void setTypes(String value)
Allows the user to set the types restriction as a comma separated list of integers representing the types the search should be restricted to.
abstract void setWildCards(int wildCards)
Sets the wild card used in the current search.
abstract boolean showResults()
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int DATE_ALL_DATES

Constant Value: 1 (0x00000001)

public static final int DATE_BETWEEN_DATES

Constant Value: 2 (0x00000002)

public static final int DATE_BETWEEN_INTERVAL

Constant Value: 1 (0x00000001)

public static final int DATE_CREATED

Constant Value: 1 (0x00000001)

public static final int DATE_DAYS

Constant Value: 2 (0x00000002)

public static final int DATE_HOURS

Constant Value: 1 (0x00000001)

public static final int DATE_MODIFIED

Constant Value: 2 (0x00000002)

public static final int DATE_MONTHS

Constant Value: 4 (0x00000004)

public static final int DATE_SPECIFIC_DATE

Constant Value: 2 (0x00000002)

public static final int DATE_WEEKS

Constant Value: 3 (0x00000003)

public static final int DATE_YEARS

Constant Value: 5 (0x00000005)

public static final String FIELD_DATE_CREATED

Constant Value: "dc"

public static final String FIELD_DATE_SUBTYPE

Constant Value: "ds"

public static final String FIELD_DATE_TYPE

Constant Value: "dt"

public static final String FIELD_DESCRIPTION

Constant Value: "de"

public static final String FIELD_END_DATE

Constant Value: "ed"

public static final String FIELD_FOLDER_ID

Constant Value: "fi"

public static final String FIELD_FOLDER_TYPE

Constant Value: "ft"

public static final String FIELD_ID

Constant Value: "id"

public static final String FIELD_INTERVAL_UNIT

Constant Value: "iu"

public static final String FIELD_INTERVAL_VALUE

Constant Value: "iv"

public static final String FIELD_NAME

Constant Value: "nm"

public static final String FIELD_OWNER_TYPE

Constant Value: "ot"

public static final String FIELD_SEARCH_OPTIONS

Constant Value: "so"

public static final String FIELD_START_DATE

Constant Value: "sd"

public static final String FIELD_TYPES

Constant Value: "ty"

public static final String FIELD_WILDCARDS

Constant Value: "wi"

public static final int OWNER_ALL

Constant Value: 1 (0x00000001)

public static final int OWNER_CURRENT

Constant Value: 2 (0x00000002)

public static final String SEARCH_STR_MAX_SIZE

Constant Value: "244"

public static final int WILDCARD_BEGINS

See Also
Constant Value: 4 (0x00000004)

public static final int WILDCARD_CONTAINS

Constant Value: 1 (0x00000001)

public static final int WILDCARD_CONTAINS_ANY

Constant Value: 16 (0x00000010)

public static final int WILDCARD_ENDS

See Also
Constant Value: 8 (0x00000008)

public static final int WILDCARD_EXACTLY

See Also
Constant Value: 2 (0x00000002)

Public Methods

public abstract int getBlockCount ()

Returns
  • the maximum time that a search will wait before returning. For more information refer to the WebSearch object.

public abstract int getDateCreated ()

Gets whether the search will be taken from the creation or modification time.

Returns
  • value that specifies whether the search will be taken from the creation or modification time.

public abstract int getDateSubType ()

Gets whether the search will be restricted based on a time or date interval.

Returns
  • whether the search will be restricted based on a time or date interval.

public abstract int getDateType ()

Gets whether the search will be restricted based on dates.

Returns
  • whether the search will be restricted based on dates.

public abstract String getDescriptionPattern ()

Returns the description pattern that the search is currently limited to. An empty string denotes that the search will not be limited by the description of the objects.

Returns
  • The current description pattern to search for.

public abstract int getDomain ()

Return the search domain, an enumeration value from EnumDSSXMLSearchDomain.

Returns
  • the search domain.

public abstract String getEndDate ()

Gets the end date if the search is restricted on a date interval. Possible values are valid dates.

Returns
  • the end date of the interval.

public abstract FolderBean getFolderBean ()

Returns
  • the FolderBean associates with this Bean.

public abstract String getFolderID ()

Gets the folder ID where the user is coming from.

Returns
  • the folder ID where the user is coming from.

public abstract String getFolderName ()

Gets the folder name where the user is coming from.

Returns
  • the folder name.

public abstract int getFolderType ()

Gets the folder type, which specifies a system folder ID.

Returns
  • the folder type.

public abstract int getIntervalUnit ()

Gets the time units to use if the search is restricted on a time interval.

Returns
  • the time units used by the current search.

public abstract String getIntervalValue ()

Gets the time value to use if the search is restricted on a time interval. Possible values are positive integers.

Returns
  • the time value that the current search will use.

public abstract int getMaxWait ()

Returns
  • the maximum time that a search will wait before returning. For more information refer to the WebSearch object.

public abstract String getNamePattern ()

Returns the pattern to search for in the name of the objects in metadata.

Returns
  • The name pattern that will be searched for.

public abstract int getOwnerType ()

Gets the owner of the objects to search for.

Returns
  • The owner of the objects to search for.

public abstract int getPollingFrequency ()

Returns
  • the time that a search will will poll for the results. For more information refer to the WebSearch object.

public abstract String getSearchID ()

Returns the search ID of the last search submitted, or the last time setSearchID was called.

Returns
  • The currently active search ID.

public abstract String getStartDate ()

Gets the start date if the search is restricted on a date interval. Possible values are valid dates.

Returns
  • the start date of the interval.

public abstract SimpleListObj getTypes ()

Returns a SimpleListObj from which types can be added or removed. Note that the SimpleListObj returned can only have java.lang.Integer objects added to it.

Returns
  • A SimpleListObj reflecting the types of objects which will be searched for.

public abstract int getWildCards ()

Returns the wild card used in the current search.

Returns
  • The wild card used in the current search.

public abstract boolean isAdvanced ()

Returns
  • whether the bean will be shown in advanced mode.

public abstract boolean isDerefrenceShortcut ()

Indicate whether DssXmlSearchDereferenceShortcut flag should be set for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }

Returns
  • the boolean value.

public abstract boolean isFieldValid (String field)

Checks if the field has valid information. In the handleRequest method all the fields are validated and saved. This method checks if the field is in the list of invalid ones.

Parameters
field the name of the field
Returns
  • true if the field contains valid information

public abstract void setAdvanced (boolean advanced)

Sets the bean to show in advaced/simple mode. In advanced mode all the search sections are displayed.

Parameters
advanced true if the bean should be render in advanced mode

public abstract void setBlockCount (int count)

Sets the Block count.

Parameters
count int value indicating the page size for the search results

public abstract void setDateCreated (int dateCreated)

Sets whether the search will be taken from the creation or modification time.

Parameters
dateCreated value that specifies whether the search will be taken from the creation or modification time.

public abstract void setDateSubType (int dateSubType)

Sets whether the search will be restricted based on a time or date interval.

Parameters
dateSubType whether the search will be restricted based on a time or date interval.

public abstract void setDateType (int dataType)

Sets whether the search will be restricted based on dates.

Parameters
dataType whether the search will be restricted based on dates.

public abstract void setDerefrenceShortcut (boolean derefrenceShortcut)

Set the DerefrenceShortcut property which indicate DssXmlSearchDereferenceShortcut flag for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }

Parameters
derefrenceShortcut the boolean value.

public abstract void setDescriptionPattern (String description)

Sets the description pattern that the search will be limited to. An empty string denotes that the search will not be limited by the description of the objects.

Parameters
description The description pattern to use in the search.

public abstract void setDomain (int domain)

Sets the search domain, an enumeration value from EnumDSSXMLSearchDomain.

Parameters
domain the search domain.

public abstract void setEndDate (String endDate)

Sets the end date of a search restricted on a date interval.

Parameters
endDate A valid date which represents the start date of the interval.

public abstract void setFolderID (String id)

Sets the folderId. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.

Parameters
id folder ID.

public abstract void setFolderType (int type)

Sets the folderType. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.

Parameters
type the folder type.

public abstract void setIntervalUnit (int intervalUnit)

Sets the time units to use if the search is restricted on a time interval.

Parameters
intervalUnit the time units used by the current search.

public abstract void setIntervalValue (String intervalValue)

Sets the time value to use if the search is restricted on a time interval. Possible values are positive integers.

Parameters
intervalValue the time value the current search will use.

public abstract void setMaxWait (int wait)

Sets the maximum time that a search will wait before returning. For more information refer to the WebSearch object.

Parameters
wait the waittime

public abstract void setNamePattern (String name)

Sets the pattern to search for in the name of the objects in metadata.

Parameters
name The name pattern that will be searched for.
See Also

public abstract void setOwnerType (int ownerType)

Sets the owner of the objects to search for.

Parameters
ownerType the owner of the objects to search for.

public abstract void setPollingFrequency (int frequency)

Sets the time that a search will will poll for the results. For more information refer to the WebSearch object.

Parameters
frequency the frequency that a search polls for results.

public abstract void setSearchID (String id)

Sets the search ID.

Parameters
id The search ID of a search which is executing or has results waiting on the Intelligence Server.
See Also

public abstract void setStartDate (String startDate)

Sets the start date of a search restricted on a date interval.

Parameters
startDate A valid date which represents the start date of the interval.

public abstract void setTypes (String value)

Allows the user to set the types restriction as a comma separated list of integers representing the types the search should be restricted to. Valid values are those defined in the EnumDSSXMLObjectTypes or the EnumDSSXMLObjectSubTypes enumerations.

public abstract void setWildCards (int wildCards)

Sets the wild card used in the current search.

Parameters
wildCards the wild card used in the current search.

public abstract boolean showResults ()

Returns
  • true if the folderBean is ready to display the search results