com.plumtree.server
Interface IPTSavedSearch

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTSavedSearch
extends IPTObject


Method Summary
 IPTSearchQuery GetSearchQuery()
          Retrieves the Search Query.
 IPTSearchRequest GetSearchRequest()
          Returns an interface to the Search Request.
 boolean GetSubscriptionEnabled()
          Returns whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
 boolean IsSubscribed(int lUserID)
          Checks whether a User is a subscriber to this SavedSearch
 int[] RetrieveSubscribedUsers()
          Retrieves all Users subscribed to this SavedSearch
 IPTSearchResponse SearchAsUser(int lUserID)
          Executes the search as a specified user.
 void SetSearchQuery(IPTSearchQuery Value)
          Sets the SearchQuery.
 void SetSearchRequest(IPTSearchRequest Value)
          Set the member Search Request object and marks the object as dirty.
 void SetSubscriptionEnabled(boolean Value)
          Sets whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
 int StoreResultPortlet(java.lang.String bstrTitle, int Type, boolean bSimple)
          Creates a Portlet corresponding to this SavedSearch which can be used to view its results
 void SubscribeUser(int lUserID)
          Adds a user id to the list of userIDs serialized with the SavedSearch object which can then be retrieved later.
 void UnSubscribeUser(int lUserID)
          Removes a user id from the list of userIDs serialized with the SavedSearch object
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetSearchRequest

public IPTSearchRequest GetSearchRequest()
Returns an interface to the Search Request.
Returns:
IPTSearchRequest

SetSearchRequest

public void SetSearchRequest(IPTSearchRequest Value)
Set the member Search Request object and marks the object as dirty.
Parameters:
Value - new IPTSearchRequest to be set

GetSearchQuery

public IPTSearchQuery GetSearchQuery()
Retrieves the Search Query. New SavedSearches will throw an exception if the SearchQuery has not yet been set.
Returns:
IPTSearchQuery

SetSearchQuery

public void SetSearchQuery(IPTSearchQuery Value)
Sets the SearchQuery. This will be the query from which the Filter is extracted.
Parameters:
Value - IPTSearchQuery to be set

SearchAsUser

public IPTSearchResponse SearchAsUser(int lUserID)
Executes the search as a specified user. Must be an administrator to use this method.
Parameters:
lUserID - userID of the user to search by
Returns:
Search results as an IPTSearchResponse.

StoreResultPortlet

public int StoreResultPortlet(java.lang.String bstrTitle,
                              int Type,
                              boolean bSimple)
Creates a Portlet corresponding to this SavedSearch which can be used to view its results
Parameters:
bstrTitle - Portlet title
Type - Portlet type (personal or community)
bSimple - should results be name only?
Returns:
portletID

SubscribeUser

public void SubscribeUser(int lUserID)
Adds a user id to the list of userIDs serialized with the SavedSearch object which can then be retrieved later.
Parameters:
lUserID - userID of the subscriber

UnSubscribeUser

public void UnSubscribeUser(int lUserID)
Removes a user id from the list of userIDs serialized with the SavedSearch object
Parameters:
lUserID - userID of the unsubscriber

RetrieveSubscribedUsers

public int[] RetrieveSubscribedUsers()
Retrieves all Users subscribed to this SavedSearch
Returns:
array of all Users subscribed to this SavedSearch

IsSubscribed

public boolean IsSubscribed(int lUserID)
Checks whether a User is a subscriber to this SavedSearch
Parameters:
lUserID - userID of the subscriber
Returns:
whether the User is subscribed to this SavedSearch

GetSubscriptionEnabled

public boolean GetSubscriptionEnabled()
Returns whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
Returns:
whether or not subscription is enabled for this object

SetSubscriptionEnabled

public void SetSubscriptionEnabled(boolean Value)
Sets whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
Parameters:
Value - whether or not subscription should be enabled for this object


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.