com.plumtree.server
Interface IPTSavedSearchManager

public interface IPTSavedSearchManager

Version:

$Revision$

Author:

Stephen Chang

Method Summary

void	AddSubscription(int lSavedSearchID, int lUserID) Adds a User to the list of subscribers serialized with a specific SavedSearch object
IPTSearchResponse	GetCachedResponse(int lSavedSearchID) Retrieves the cached Search Results for a specific SavedSearch
int[]	GetContentPortletIDs() Returns the IDs of the properties returned via the search
IPTSearchResponse	GetFollowupResults(int _lSavedSearchID, int _lUserID, int _lPropID, int _lSkipResults, IPTFilter _filter) Conducts a follow up search to the original SavedSearch object
java.lang.Object[]	GetReturnedPropertyIDs(int _lSavedSearchID) Returns the IDs of the properties returned via the search
boolean	IsSubscribed(int lSavedSearchID, int lUserID) Checks whether a specific user is subscribed to a specific SavedSearch object
void	RemoveSubscription(int lSavedSearchID, int lUserID) Removes a User from the list of subscribers serialized with a specific SavedSearch object

Method Detail

GetCachedResponse

IPTSearchResponse GetCachedResponse(int lSavedSearchID)

Retrieves the cached Search Results for a specific SavedSearch

Parameters:

lSavedSearchID - savedsearchID

Returns:

Search Results

IsSubscribed

boolean IsSubscribed(int lSavedSearchID,
                     int lUserID)

Checks whether a specific user is subscribed to a specific SavedSearch object

Parameters:

lSavedSearchID - savedsearchID

lUserID - userID of the subscriber

Returns:

whether the User is subscribed

AddSubscription

void AddSubscription(int lSavedSearchID,
                     int lUserID)

Adds a User to the list of subscribers serialized with a specific SavedSearch object

Parameters:

lSavedSearchID - savedsearchID

lUserID - userID of the subscriber

RemoveSubscription

void RemoveSubscription(int lSavedSearchID,
                        int lUserID)

Removes a User from the list of subscribers serialized with a specific SavedSearch object

Parameters:

lSavedSearchID - savedsearchID

lUserID - userID of the unsubscriber

GetFollowupResults

IPTSearchResponse GetFollowupResults(int _lSavedSearchID,
                                     int _lUserID,
                                     int _lPropID,
                                     int _lSkipResults,
                                     IPTFilter _filter)

Conducts a follow up search to the original SavedSearch object

Parameters:

lSavedSearchID - original savedsearchID

lUserID - userID of the user wanting to do a follow up search

lPropID - propid to sort by

number - of results to skip @see PT_SEARCH_SETTING.PT_SEARCHSETTING_SKIPRESULTS

filter - the follow up search filter

GetReturnedPropertyIDs

java.lang.Object[] GetReturnedPropertyIDs(int _lSavedSearchID)

Returns the IDs of the properties returned via the search

Parameters:

lSavedSearchID - original savedsearchID

GetContentPortletIDs

int[] GetContentPortletIDs()

Returns the IDs of the properties returned via the search

Parameters:

lSavedSearchID - original savedsearchID