com.microstrategy.web.app.beans.SearchBean |
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.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
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 |
getMaxObjects()
Returns the maximum number of objects the search is configured to return.
| ||||||||||
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 |
setMaxObjects(int maxObjects)
Sets the maximum number of objects that the search will return.
| ||||||||||
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
WebSearch
object.
Gets whether the search will be taken from the creation or modification time.
Gets whether the search will be restricted based on a time or date interval.
Gets whether the search will be restricted based on dates.
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.
Return the search domain, an enumeration value from EnumDSSXMLSearchDomain
.
Gets the end date if the search is restricted on a date interval. Possible values are valid dates.
Gets the folder ID where the user is coming from.
Gets the folder name where the user is coming from.
Gets the folder type, which specifies a system folder ID.
Gets the time units to use if the search is restricted on a time interval.
Gets the time value to use if the search is restricted on a time interval. Possible values are positive integers.
Returns the maximum number of objects the search is configured to return. By default, this value is -1, meaning return all objects, but it can be changed by calling setMaxObjects.
WebSearch
object.
Returns the pattern to search for in the name of the objects in metadata.
Gets the owner of the objects to search for.
WebSearch
object.
Returns the search ID of the last search submitted, or the last time setSearchID was called.
Gets the start date if the search is restricted on a date interval. Possible values are valid dates.
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.
SimpleListObj
reflecting the types of objects which will be searched for.
Returns the wild card used in the current search.
Indicate whether DssXmlSearchDereferenceShortcut flag should be set for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }
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.
field | the name of the field |
---|
Sets the bean to show in advaced/simple mode. In advanced mode all the search sections are displayed.
advanced | true if the bean should be render in advanced mode |
---|
Sets the Block count.
count | int value indicating the page size for the search results
|
---|
Sets whether the search will be taken from the creation or modification time.
dateCreated | value that specifies whether the search will be taken from the creation or modification time. |
---|
Sets whether the search will be restricted based on a time or date interval.
dateSubType | whether the search will be restricted based on a time or date interval. |
---|
Sets whether the search will be restricted based on dates.
dataType | whether the search will be restricted based on dates. |
---|
Set the DerefrenceShortcut property which indicate DssXmlSearchDereferenceShortcut flag for search, see {@com.microstrategy.webapi.EnumDSSXMLSearchFlags }
derefrenceShortcut | the boolean value. |
---|
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.
description | The description pattern to use in the search. |
---|
Sets the search domain, an enumeration value from EnumDSSXMLSearchDomain
.
domain | the search domain. |
---|
Sets the end date of a search restricted on a date interval.
endDate | A valid date which represents the start date of the interval. |
---|
Sets the folderId. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.
id | folder ID. |
---|
Sets the folderType. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.
type | the folder type. |
---|
Sets the time units to use if the search is restricted on a time interval.
intervalUnit | the time units used by the current search. |
---|
Sets the time value to use if the search is restricted on a time interval. Possible values are positive integers.
intervalValue | the time value the current search will use. |
---|
Sets the maximum number of objects that the search will return. Default is -1, meaning return all objects.
maxObjects | The maximum number of objects to return from the search. |
---|
Sets the maximum time that a search will wait before returning. For more information
refer to the WebSearch
object.
wait | the waittime |
---|
Sets the pattern to search for in the name of the objects in metadata.
name | The name pattern that will be searched for. |
---|
Sets the owner of the objects to search for.
ownerType | the owner of the objects to search for. |
---|
Sets the time that a search will will poll for the results. For more information
refer to the WebSearch
object.
frequency | the frequency that a search polls for results. |
---|
Sets the search ID.
id | The search ID of a search which is executing or has results waiting on the Intelligence Server. |
---|
Sets the start date of a search restricted on a date interval.
startDate | A valid date which represents the start date of the interval. |
---|
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.
Sets the wild card used in the current search.
wildCards | the wild card used in the current search. |
---|