com.plumtree.portaluiinfrastructure.search
Interface IBaseSearchQueryRO

All Known Subinterfaces:

IBaseSearchResultModelRO, ISearchQueryRO, ISearchResultModelRO

All Known Implementing Classes:

SearchResultModel

public interface IBaseSearchQueryRO

Author:

CraigS

Method Summary

int	GetAbstractTypeRestrictions() Returns the abstract types the search was restricted to, if any.
int[]	GetAdminFolderRestrictions() Returns the admin folders the search was restricted to, if any.
int	GetApplicationRestrictions() Returns the applications the search was restricted to, if any.
int[]	GetCollabProjectRestrictions() Returns the Collab projects the search was restricted to, if any.
java.lang.String	GetCommunityNameForID(int id) Utility method to lookup the name of a community given its id.
int[]	GetCommunityRestrictions() Returns the communities the search was restricted to, if any.
int[]	GetDocFolderRestrictions() Returns the document folders the search was restricted to, if any.
java.lang.String	GetFolderNameForID(int id, boolean isAdmin) Utility method to lookup the name of a folder given its id.
boolean	GetIncludeSubfolders() Returns true if the folder restrictions included subfolders.
java.lang.String	GetLanguageRestriction() Returns the two-character code for the language restriction, if any, or null otherwise.
java.lang.String	GetLocalizedSearchString() Returns the original search string with meta search substrings being replaced with locale specific substrings e.g: tag:test will be returned as etiqueta:test in spanish
int[]	GetObjectTypeRestrictions() Returns the types (as PT_CLASSIDs) the search was restricted to, if any.
java.lang.String	GetPortletNameForID(int id) Utility method to lookup the name of a portlet given its id.
int[]	GetPortletRestrictions() Returns the Content Server portlets the search was restricted to, if any.
java.lang.String	GetSearchString() Returns the user's original search string.

Method Detail

GetAbstractTypeRestrictions

int GetAbstractTypeRestrictions()

Returns the abstract types the search was restricted to, if any.

GetAdminFolderRestrictions

int[] GetAdminFolderRestrictions()

Returns the admin folders the search was restricted to, if any.

GetApplicationRestrictions

int GetApplicationRestrictions()

Returns the applications the search was restricted to, if any.

GetCommunityNameForID

java.lang.String GetCommunityNameForID(int id)

Utility method to lookup the name of a community given its id.

GetCommunityRestrictions

int[] GetCommunityRestrictions()

Returns the communities the search was restricted to, if any.

GetPortletRestrictions

int[] GetPortletRestrictions()

Returns the Content Server portlets the search was restricted to, if any.

GetCollabProjectRestrictions

int[] GetCollabProjectRestrictions()

Returns the Collab projects the search was restricted to, if any.

GetPortletNameForID

java.lang.String GetPortletNameForID(int id)

Utility method to lookup the name of a portlet given its id.

GetDocFolderRestrictions

int[] GetDocFolderRestrictions()

Returns the document folders the search was restricted to, if any.

GetFolderNameForID

java.lang.String GetFolderNameForID(int id,
                                    boolean isAdmin)

Utility method to lookup the name of a folder given its id. Pass isAdmin = true for admin folders, false for doc folders.

GetIncludeSubfolders

boolean GetIncludeSubfolders()

Returns true if the folder restrictions included subfolders.

GetLanguageRestriction

java.lang.String GetLanguageRestriction()

Returns the two-character code for the language restriction, if any, or null otherwise.

GetObjectTypeRestrictions

int[] GetObjectTypeRestrictions()

Returns the types (as PT_CLASSIDs) the search was restricted to, if any.

GetSearchString

java.lang.String GetSearchString()

Returns the user's original search string.

GetLocalizedSearchString

java.lang.String GetLocalizedSearchString()

Returns the original search string with meta search substrings being replaced with locale specific substrings e.g: tag:test will be returned as etiqueta:test in spanish

Returns: