Aqualogic Interaction API  
 

IPTSavedSearch Members

IPTSavedSearch overview

Public Instance Methods

FollowupSearch 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.
GetReturnProps Returns the props that have been returned via the search.
GetSearchQuery Retrieves the Search Query. New SavedSearches will throw an exception if the SearchQuery has not yet been set.
GetSearchRequest Returns an interface to the Search Request.
GetSubscriptionEnabled Returns whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
IsSubscribed Checks whether a User is a subscriber to this SavedSearch
QueryPortletList Returns the list of portlets that reference this query. Use PT_PROPIDS.PT_PROPID_CLASSID and PT_PROPIDS.PT_PROPID_OBJECTID
RetrieveSubscribedUsers Retrieves all Users subscribed to this SavedSearch
SearchAsUser Executes the search as a specified user. Must be an administrator to use this method.
SetReturnProps Sets the props that will be used as PT_SEARCH_SETTING.PT_SEARCHSETTING_RET_PROPS in the search.
SetSearchQuery Sets the SearchQuery. This will be the query from which the Filter is extracted.
SetSearchRequest Set the member Search Request object and marks the object as dirty.
SetSubscriptionEnabled Sets whether the storage and retrieval of Subscriber userIDs is supported on this SavedSearch object
StoreResultPortlet Creates a Portlet corresponding to this SavedSearch which can be used to view its results
SubscribeUser Adds a user id to the list of userIDs serialized with the SavedSearch object which can then be retrieved later.
UnSubscribeUser Removes a user id from the list of userIDs serialized with the SavedSearch object

See Also

IPTSavedSearch Interface | com.plumtree.server Namespace