com.plumtree.portaluiinfrastructure.helpers
Interface IBannerSearchHelper

All Known Implementing Classes:

BannerSearchHelperService

public interface IBannerSearchHelper

Method Summary

java.lang.String	GetBannerSearchPreferenceSortOrder(AActivitySpace _parent)
int	GetIntSessionSetting(IPTSessionInfo sessionInfo, java.lang.String settingName, int def) Helper method to get an integer setting from the user's session.
int	GetIntSetting(IPTSessionInfo sessionInfo, java.lang.String settingName, int def) Helper method to get an integer setting out of the database
java.lang.String	GetPathwaysClassIdStringValue(int filterId)
XPArrayList	GetPortalObjectTypes(IPTSessionInfo sessionInfo, int objectTypeBitmask) helper method to decipher the bitmask value
XPArrayList	GetSearchConstraints(AActivitySpace owner) looks up the bitmask for search object constraints this function came from BannerStartSearchControl.GetPreferences()
java.lang.String	GetStringSetting(IPTSessionInfo sessionInfo, java.lang.String settingName, java.lang.String def) Helper method to get a String setting out of the database
XPArrayList	setCollabItems(XPArrayList collabFilter)
XPArrayList	setContentItems(XPArrayList contentFilter)
java.lang.String	SetPathwaysSearchHistory(java.lang.Object[] queryArray)

Method Detail

GetSearchConstraints

XPArrayList GetSearchConstraints(AActivitySpace owner)

looks up the bitmask for search object constraints this function came from BannerStartSearchControl.GetPreferences()

Parameters:

owner - AActivityspace to get user session

GetPortalObjectTypes

XPArrayList GetPortalObjectTypes(IPTSessionInfo sessionInfo,
                                 int objectTypeBitmask)

helper method to decipher the bitmask value

Parameters:

objectTypeBitmask - The bitmask value of the object types to search for

Returns:

list of Portal Object Types from User Search Preferences.

SetPathwaysSearchHistory

java.lang.String SetPathwaysSearchHistory(java.lang.Object[] queryArray)

GetBannerSearchPreferenceSortOrder

java.lang.String GetBannerSearchPreferenceSortOrder(AActivitySpace _parent)

GetPathwaysClassIdStringValue

java.lang.String GetPathwaysClassIdStringValue(int filterId)

setCollabItems

XPArrayList setCollabItems(XPArrayList collabFilter)

setContentItems

XPArrayList setContentItems(XPArrayList contentFilter)

GetStringSetting

java.lang.String GetStringSetting(IPTSessionInfo sessionInfo,
                                  java.lang.String settingName,
                                  java.lang.String def)

Helper method to get a String setting out of the database

Parameters:

sessionInfo - the current user's IPTSessionInfo object.

settingName - the name of the desired setting.

def - a default value to return if the setting is not found in the database.

Returns:

the value of the setting, or def if not found.

GetIntSetting

int GetIntSetting(IPTSessionInfo sessionInfo,
                  java.lang.String settingName,
                  int def)

Helper method to get an integer setting out of the database

Parameters:

sessionInfo - the current user's IPTSessionInfo object.

settingName - the name of the desired setting.

def - a default value to return if the setting is not found in the database.

Returns:

the value of the setting, or def if not found.

GetIntSessionSetting

int GetIntSessionSetting(IPTSessionInfo sessionInfo,
                         java.lang.String settingName,
                         int def)

Helper method to get an integer setting from the user's session.

Parameters:

sessionInfo - the current user's IPTSessionInfo object.

settingName - the name of the desired setting.

def - a default value to return if the setting is not found in the session.

Returns:

the value of the setting, or def if not found.