Plumtree Portal UI  
 

SearchSettingCollection Methods

The methods of the SearchSettingCollection class are listed below. For a complete list of SearchSettingCollection class members, see the SearchSettingCollection Members topic.

Public Static Methods

encodeRequestSettings Encode all settings in the provided IPTSearchRequest, ready for URL encoding, into the provided XPHashtable. The map keys are Strings (e.g. PT_SEARCHSETTING_OBJTYPES_S) prepended with the provided prefix. The values are String[]-ified setting values. inclusions and exclusions are IXPCollections of Integers. If the inclusions collection is non-null, only settings contained within it are included in the returned map. Any settings contained in the exclusions collection are omitted from the returned map.
GetPageContextSettings 
getSettingIdFromString Static helper method to map a string (i.e. a URL parameter) to a PT_SEARCH_SETTING value.
getStringFromSettingId Static helper method to map a PT_SEARCH_SETTING to the URL parameter used to encode it
parseURLString Parse the URL-ified String[] setting value and return an Object that can be passed to add() (and from there into IPTSearchRequest.SetSettings()).
stringifySettingValue Return a stringified version of v that can be used in an URL

Public Instance Methods

addOverloaded. Add a setting to the map (for use only within the search package)
dump Helper method for debugging
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetSettingIDs Get an enumeration of the settings stored in the collection
GetSettingValue Get an enumeration of the settings stored in the collection
GetSize Get the size of the map
GetType (inherited from Object)Gets the Type of the current instance.
IsSimpleCommunityRestriction Helper method that indicates whether this collection simply restricts a search to a community. Used by the UI to replace the "Search with Same Restrictions" message with "Search in Same Community" when possible.
IsSimpleFolderRestriction Helper method that indicates whether this collection simply restricts a search to a folder (possibly including subfolders). Used by the UI to replace the "Search with Same Restrictions" message with "Search in Same Folder" when possible.
merge Merge another batch of settings into ours
ToString (inherited from Object)Returns a String that represents the current Object.
updateRequest Update an IPTSearchRequest with our settings

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

SearchSettingCollection Class | com.plumtree.portaluiinfrastructure.search Namespace