com.plumtree.server
Class PT_SEARCH_SETTING

java.lang.Object
  com.plumtree.server.PT_SEARCH_SETTING

public final class PT_SEARCH_SETTING
extends java.lang.Object

These are settings that can be get and set on an IPTSearchRequest, via GetSettings() and SetSettings(). The value type and default value for each setting id is indicated here.

Version:

$Revision$

Author:

CraigS

See Also:

IPTSearchRequest

Field Summary

static int	PT_SEARCHSETTING_ABSTYPES Abstractified object types to constrain the search to (documents, containers, or other types).
static int	PT_SEARCHSETTING_ACCESS_LEVEL Searches ordinarily return items that the current user has READ access to; pass in a PT_ACCESS_LEVEL value to restrict the search to a higher level of access.
static int	PT_SEARCHSETTING_ADMINFOLDERS Admin folders to constrain the search.
static int	PT_SEARCHSETTING_APPS Applications to constrain the search to (portal, collab, or content).
static int	PT_SEARCHSETTING_ASSOC_COLLAB_PROJECT_ID Constrains Collab Server matches to items associated with the specified project; has no effect on other results (use the APPS setting if you only want Collab results to be returned).
static int	PT_SEARCHSETTING_ASSOC_PORTLET_ID Constrains Content Server matches to items associated with the specified portlet IDs; has no effect on other results (use the APPS setting if you only want Content results to be returned).
static int	PT_SEARCHSETTING_BESTBETS Whether to apply Best Bets to this query.
static int	PT_SEARCHSETTING_COMMUNITY_ID Communities to constrain the search.
static int	PT_SEARCHSETTING_DDFOLDERS Document folders to constrain the search.
static int	PT_SEARCHSETTING_DOCUMENT_TYPE Constrains document matches to the user selected type which is one of the ObjectIDs listed in PTDOCUMENTTYPE table.
static int	PT_SEARCHSETTING_GADGET_ALIGNMENT Constrains portlet matches to match any of the specified portlet alignments; has no effect on other results (use the OBJTYPES and APPS settings if you only want portlets to be returned).
static int	PT_SEARCHSETTING_GADGET_FIELDS Requests that certain fields defined only for portlets be returned as part of search results.
static int	PT_SEARCHSETTING_GADGET_SEARCH_TYPE Constrains portlet matches to obey certain special case behavior; legal values are null or empty string, "bannersearch", and "noncommunityfolder".
static int	PT_SEARCHSETTING_GADGET_TYPE Constrains portlet matches to match any of the specified portlet types; has no effect on other results (use the OBJTYPES and APPS settings if you only want portlets to be returned).
static int	PT_SEARCHSETTING_GROUPBYPROP Specifies categorization for the results.
static int	PT_SEARCHSETTING_INCLUDE_SUBFOLDERS If DDFOLDERS and/or ADMINFOLDERS are set, whether to include their subfolders in the search.
static int	PT_SEARCHSETTING_INCLUDE_USUAL_FIELDS If true, a standard set of fields (name, description, ACL, etc) that is sufficient for the portal's standard search results page will be returned for each search result.
static int	PT_SEARCHSETTING_INITIALSEARCHSTRING Misnamed; does NOT set the actual search string.
static int	PT_SEARCHSETTING_KWIC Whether to make keyword-in-context ("KWIC") information available as part of the search result.
static int	PT_SEARCHSETTING_LANGUAGE Language in which to parse the user's query (such as en, de).
static int	PT_SEARCHSETTING_LIMITBYLOCALE Whether to limit to results in the same language used to parse the user's query.
static int	PT_SEARCHSETTING_MAXNUMGROUPS Maximum number of categories to generate, when GROUPBYPROP is used.
static int	PT_SEARCHSETTING_MAXRESULTS Maximum number of results to return.
static int	PT_SEARCHSETTING_OBJIDS Object IDs to constrain the search; used along with OBJTYPES and APPS to check whether specific objects are indexed.
static int	PT_SEARCHSETTING_OBJTYPES Portal object types (array of PT_CLASSIDS values) to constrain the portal part of the search.
static int	PT_SEARCHSETTING_ORDERBY ID of a property used to order the results, overriding the search server's normal relevance ranking.
static int	PT_SEARCHSETTING_QUERYTYPE A "query type" that is logged as part of the search server logs within the tag queryType.
static int	PT_SEARCHSETTING_RET_PROPS Requests that a set of Plumtree properties (identified by id) be returned for each search result, in addition to the standard intrinsic properties (name, summary, etc) that are returned if the INCLUDE_USUAL_FIELDS setting is true.
static int	PT_SEARCHSETTING_SECURITY Deprecated.
static int	PT_SEARCHSETTING_SKIPRESULTS Number of results to skip before returning results.
static int	PT_SEARCHSETTING_SPELLCHECK Whether to attempt to spell-correct the query if any terms are not recognized.
static int	PT_SEARCHSETTING_THESAURUS Whether to use the search server's thesaurus to expand the query.
static int	PT_SEARCHSETTING_TIMEOUT The maximum time, in seconds, that the search server should process this query.
static int	PT_SEARCHSETTING_USE_SHORT_TIMEOUT Whether to use a short (30 second) search server connection timeout instead of a long (10 minute) timeout.
static int	PT_SEARCHSETTING_USER_IS_GUEST Constrains user matches to guest or non-guest users.

Constructor Summary

PT_SEARCH_SETTING()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PT_SEARCHSETTING_LANGUAGE

public static final int PT_SEARCHSETTING_LANGUAGE

Language in which to parse the user's query (such as en, de). Default: user's default session language. Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_LIMITBYLOCALE

public static final int PT_SEARCHSETTING_LIMITBYLOCALE

Whether to limit to results in the same language used to parse the user's query. Default: false. Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_SKIPRESULTS

public static final int PT_SEARCHSETTING_SKIPRESULTS

Number of results to skip before returning results. To start at the beginning, use 0. For results 11-20, use 10. Default: 0. Value type: Integer.

See Also:

Constant Field Values

PT_SEARCHSETTING_MAXRESULTS

public static final int PT_SEARCHSETTING_MAXRESULTS

Maximum number of results to return. A value of 10 could return results 1-10, 11-20, or 104-113, depending on the value of SKIPRESULTS. Default: 10. Value type: Integer.

See Also:

Constant Field Values

PT_SEARCHSETTING_APPS

public static final int PT_SEARCHSETTING_APPS

Applications to constrain the search to (portal, collab, or content). A value of 0 is synonymous with setting all bits (i.e. all applications). Default: 0. Value type: Integer (bitflag of PT_SEARCH_APPS values).

See Also:

PT_SEARCH_APPS, Constant Field Values

PT_SEARCHSETTING_ABSTYPES

public static final int PT_SEARCHSETTING_ABSTYPES

Abstractified object types to constrain the search to (documents, containers, or other types). A value of 0 is synonymous with setting all bits (i.e. all types). Default: 0. Value type: Integer (bitflag of PT_SEARCH_ABSTYPES values).

See Also:

PT_SEARCH_ABSTYPES, Constant Field Values

PT_SEARCHSETTING_OBJTYPES

public static final int PT_SEARCHSETTING_OBJTYPES

Portal object types (array of PT_CLASSIDS values) to constrain the portal part of the search. Don't forget to set the APPS setting if you don't want Collab or Content items! Default: null (no restriction) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_DDFOLDERS

public static final int PT_SEARCHSETTING_DDFOLDERS

Document folders to constrain the search. Has no effect on types other than cards (documents) and doc folders, or on Collab or Content items. Set the OBJTYPES and APPS settings as well if you don't want these. Default: null (no restriction) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_ADMINFOLDERS

public static final int PT_SEARCHSETTING_ADMINFOLDERS

Admin folders to constrain the search. Has no effect on cards (documents), doc folders, or Collab or Content items. Set the OBJTYPES and APPS settings as well if you don't want these. Default: null (no restriction) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_OBJIDS

public static final int PT_SEARCHSETTING_OBJIDS

Object IDs to constrain the search; used along with OBJTYPES and APPS to check whether specific objects are indexed. Default: null (no restriction) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_INCLUDE_SUBFOLDERS

public static final int PT_SEARCHSETTING_INCLUDE_SUBFOLDERS

If DDFOLDERS and/or ADMINFOLDERS are set, whether to include their subfolders in the search. Default: true Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_COMMUNITY_ID

public static final int PT_SEARCHSETTING_COMMUNITY_ID

Communities to constrain the search. Default: null (no restriction) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_KWIC

public static final int PT_SEARCHSETTING_KWIC

Whether to make keyword-in-context ("KWIC") information available as part of the search result. If you're not showing highlighted search keywords, turning this off may make your searches slightly faster. Default: true Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_SPELLCHECK

public static final int PT_SEARCHSETTING_SPELLCHECK

Whether to attempt to spell-correct the query if any terms are not recognized. (Note that the portal administrator can disable this feature globally by changing a server configurarion setting.) Default: false Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_BESTBETS

public static final int PT_SEARCHSETTING_BESTBETS

Whether to apply Best Bets to this query. Default: false Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_TIMEOUT

public static final int PT_SEARCHSETTING_TIMEOUT

The maximum time, in seconds, that the search server should process this query. This is separate from USE_SHORT_TIMEOUT (but unfortunately has a similar name), which controls the timeout used when obtaining an connection to the search server. Default: controlled by the search server Value type: Integer

See Also:

Constant Field Values

PT_SEARCHSETTING_QUERYTYPE

public static final int PT_SEARCHSETTING_QUERYTYPE

A "query type" that is logged as part of the search server logs within the tag queryType. Certain special values used internally within the portal server can trigger special case behavior. Default: empty string Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_ORDERBY

public static final int PT_SEARCHSETTING_ORDERBY

ID of a property used to order the results, overriding the search server's normal relevance ranking. The property must be of numeric or date type. Make the ID negative to order the results in descending order, positive for ascending order. Default: 0 (no property used for ordering; order by relevance) Value type: Integer

See Also:

Constant Field Values

PT_SEARCHSETTING_SECURITY

public static final int PT_SEARCHSETTING_SECURITY

Deprecated.

No longer used.

See Also:

Constant Field Values

PT_SEARCHSETTING_ACCESS_LEVEL

public static final int PT_SEARCHSETTING_ACCESS_LEVEL

Searches ordinarily return items that the current user has READ access to; pass in a PT_ACCESS_LEVEL value to restrict the search to a higher level of access. Default: PT_ACCESS_LEVEL_READ Value type: Integer

See Also:

Constant Field Values

PT_SEARCHSETTING_INITIALSEARCHSTRING

public static final int PT_SEARCHSETTING_INITIALSEARCHSTRING

Misnamed; does NOT set the actual search string. Instead, sets a string that is logged in the search server logs within initialSearchString tags. The portal's log analysis feature uses this logged string to find the most frequent searches. Searches that are not run through the regular portal UI should not set this setting. Default: empty string Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_THESAURUS

public static final int PT_SEARCHSETTING_THESAURUS

Whether to use the search server's thesaurus to expand the query. Note that the portal administrator must enable the thesaurus globally by changing a server configuration setting. Default: false Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_RET_PROPS

public static final int PT_SEARCHSETTING_RET_PROPS

Requests that a set of Plumtree properties (identified by id) be returned for each search result, in addition to the standard intrinsic properties (name, summary, etc) that are returned if the INCLUDE_USUAL_FIELDS setting is true. Default: null Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_INCLUDE_USUAL_FIELDS

public static final int PT_SEARCHSETTING_INCLUDE_USUAL_FIELDS

If true, a standard set of fields (name, description, ACL, etc) that is sufficient for the portal's standard search results page will be returned for each search result. In this case, request any additional Properties via the RET_PROPS setting. If false, you must request each returned Property via the PT_SEARCHSETTING_RET_PROPS setting. Default: true Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_GROUPBYPROP

public static final int PT_SEARCHSETTING_GROUPBYPROP

Specifies categorization for the results. Legal values include "ancestors" (to categorize by folder) and "subtype" (to categorize by object type. Other categorizations may be configured by a portal administrator. Default: empty string, no categorization Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_MAXNUMGROUPS

public static final int PT_SEARCHSETTING_MAXNUMGROUPS

Maximum number of categories to generate, when GROUPBYPROP is used. Any other categories are lumped into an "all others" group. Default: 10 Value type: Integer

See Also:

Constant Field Values

PT_SEARCHSETTING_GADGET_FIELDS

public static final int PT_SEARCHSETTING_GADGET_FIELDS

Requests that certain fields defined only for portlets be returned as part of search results. See the PT_SEARCH_INTERNAL_FIELD enumeration for a list of these. Default: false Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_GADGET_TYPE

public static final int PT_SEARCHSETTING_GADGET_TYPE

Constrains portlet matches to match any of the specified portlet types; has no effect on other results (use the OBJTYPES and APPS settings if you only want portlets to be returned). Default: null (no constraint) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_GADGET_ALIGNMENT

public static final int PT_SEARCHSETTING_GADGET_ALIGNMENT

Constrains portlet matches to match any of the specified portlet alignments; has no effect on other results (use the OBJTYPES and APPS settings if you only want portlets to be returned). Default: null (no constraint) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_ASSOC_PORTLET_ID

public static final int PT_SEARCHSETTING_ASSOC_PORTLET_ID

Constrains Content Server matches to items associated with the specified portlet IDs; has no effect on other results (use the APPS setting if you only want Content results to be returned). Default: null (no constraint) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_GADGET_SEARCH_TYPE

public static final int PT_SEARCHSETTING_GADGET_SEARCH_TYPE

Constrains portlet matches to obey certain special case behavior; legal values are null or empty string, "bannersearch", and "noncommunityfolder". Default: null or empty string (no constraint) Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_ASSOC_COLLAB_PROJECT_ID

public static final int PT_SEARCHSETTING_ASSOC_COLLAB_PROJECT_ID

Constrains Collab Server matches to items associated with the specified project; has no effect on other results (use the APPS setting if you only want Collab results to be returned). Default: null (no constraint) Value type: int[]

See Also:

Constant Field Values

PT_SEARCHSETTING_USER_IS_GUEST

public static final int PT_SEARCHSETTING_USER_IS_GUEST

Constrains user matches to guest or non-guest users. Legal values are null (for no restriction), "regular" for non-guest users, or "guest" for guest users. Default: null (no constraint) Value type: String

See Also:

Constant Field Values

PT_SEARCHSETTING_USE_SHORT_TIMEOUT

public static final int PT_SEARCHSETTING_USE_SHORT_TIMEOUT

Whether to use a short (30 second) search server connection timeout instead of a long (10 minute) timeout. Default: false (use long timeout) Value type: Integer, where zero==false, nonzero==true.

See Also:

Constant Field Values

PT_SEARCHSETTING_DOCUMENT_TYPE

public static final int PT_SEARCHSETTING_DOCUMENT_TYPE

Constrains document matches to the user selected type which is one of the ObjectIDs listed in PTDOCUMENTTYPE table.

See Also:

Constant Field Values

Constructor Detail

PT_SEARCH_SETTING

public PT_SEARCH_SETTING()