|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
| 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 |
public IPTSearchRequest GetSearchRequest()
public void SetSearchRequest(IPTSearchRequest Value)
Value - new IPTSearchRequest to be setpublic IPTSearchQuery GetSearchQuery()
public void SetSearchQuery(IPTSearchQuery Value)
Value - IPTSearchQuery to be setpublic IPTSearchResponse SearchAsUser(int lUserID)
lUserID - userID of the user to search by
public int StoreResultPortlet(java.lang.String bstrTitle,
int Type,
boolean bSimple)
bstrTitle - Portlet titleType - Portlet type (personal or community)bSimple - should results be name only?public void SubscribeUser(int lUserID)
lUserID - userID of the subscriberpublic void UnSubscribeUser(int lUserID)
lUserID - userID of the unsubscriberpublic int[] RetrieveSubscribedUsers()
public boolean IsSubscribed(int lUserID)
lUserID - userID of the subscriberpublic boolean GetSubscriptionEnabled()
public void SetSubscriptionEnabled(boolean Value)
Value - whether or not subscription should be enabled for this object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||