WebCenter Interaction API  
 

IPTSavedSearch Members

IPTSavedSearch overview

Public Instance Methods

public methodFollowupSearch creates a follow up query based on filter and 'Ands' follow up qry with original query in a follow up Search call. The followup qry can also be ordered by a sortable property id. If the propid is specified but the filter is null, this has the effect of reordering the original qry.
public methodGetReturnProps Returns the props that have been returned via the search.
public methodGetSearchQuery Retrieves the Search Query. New SavedSearches will throw an exception if the SearchQuery has not yet been set.
public methodGetSearchRequest Returns an interface to the Search Request.
public methodGetSubscriptionEnabled Returns whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
public methodIsSubscribed Checks whether a User is a subscriber to this SavedSearch
public methodQueryPortletList Returns the list of portlets that reference this query. Use PT_PROPIDS.PT_PROPID_CLASSID and PT_PROPIDS.PT_PROPID_OBJECTID
public methodRetrieveSubscribedUsers Retrieves all Users subscribed to this SavedSearch
public methodSearchAsUser Executes the search as a specified user. Must be an administrator to use this method.
public methodSetReturnProps Sets the props that will be used as PT_SEARCH_SETTING.PT_SEARCHSETTING_RET_PROPS in the search.
public methodSetSearchQuery Sets the SearchQuery. This will be the query from which the Filter is extracted.
public methodSetSearchRequest Set the member Search Request object and marks the object as dirty.
public methodSetSubscriptionEnabled Sets whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
public methodStoreResultPortlet Creates a Portlet corresponding to this SavedSearch which can be used to view its results
public methodSubscribeUser Adds a user id to the list of userIDs serialized with the SavedSearch object which can then be retrieved later.
public methodUnSubscribeUser Removes a user id from the list of userIDs serialized with the SavedSearch object

See Also

IPTSavedSearch Interface | com.plumtree.server Namespace