IPTSearchBestBetMaintenance overview
Public Instance Methods
 AddBestBet | Add a new Best Bet to the add list. This call will throw an exception if called by anyone but the administrator. |
| ApplyChanges | Saves all changes to the database and commits to the search server. This call will throw an exception if called by anyone but the administrator. |
| CanAddBestBet | Checks wether a particular Best Bet is addable or not. It may be addable if a Best Bet with the same newTrigger already exists. This call will throw an exception if called by anyone but the administrator. |
| CancelChanges | Undoes all changes made. This call will throw an exception if called by anyone but the administrator. |
| DeleteAll | Deletes all Best Bets. This call will throw an exception if called by anyone but the administrator. |
| DeleteByTriggerString | Takes a list of trigger string, and deletes those triggers. This call will throw an exception if called by anyone but the administrator. |
| DeleteFromDisplayedList | Takes a list of indices into the displayed list array, and marks the best bets for deletion. This call will throw an exception if called by anyone but the administrator. |
| FindFirstTargetForTrigger | Like the other Find calls, this method should not strictly be here. Given a Best Bet trigger string, this method returns the first best bet target. If the calling user does not have access to the first target document, or if the trigger does not exist, a null IPTSResult is returned. The IPTSResult returned will always have these fields: PortalCollection().Application(), PortalCollection().FolderACL(), PortalCollection().ReadACL(), ContentCollection().ACL(), and CollabCollection().ACL(), so those fields do not need to be retrieved. |
| FindTriggersContainingTarget | |
| FindTriggersWithFirstTarget | |
| GetAddedCount | Get a count of the # of items added since the last commit. |
| GetDeletedCount | Get a count of the # of items deleted since the last commit. |
| GetDisplayedCount | Get the # of displayed items. |
| GetDisplayedItemSetupString | Get the item setup string. (the search string used to find targets) |
| GetDisplayedItemTargets | Gets an IXPList of IPTBestBetTarget items. |
| GetDisplayedItemTrigger | Get the item's trigger string. |
| GetShowingAll | Determine of there is a query restriction or if all Best Bets are being displayed. |
| GetTotalCount | Get the total count of Best Bets. |
| HasBestBetBeenDeleted | Returns true if the Best Bet with the given trigger string has been deleted since the last "ApplyChanges()" call. |
| HasDisplayedItemBeenDeleted | Returns true if the display item at the given index has been deleted since the last "ApplyChanges()" call. |
| HasDisplayedItemBeenNewlyAdded | Returns true if the display item at the given index was newly added since the last "ApplyChanges()" call. |
| RefreshDisplayList | Call to refresh the display list. This call will throw an exception if called by anyone but the administrator. |
| SetNumResultsAskedFor | Set the number of items to get when fetching Best Bets (size of view window). This call has no effect until "RefreshDisplayList()" is called. |
| SetSearchString | Set the search string to use to limit the display list. The wildcard character "*" is allowed at the end of the string. If the "*" is not the last character, the search string will be truncated upto the "*". This call has no effect until "RefreshDisplayList()" is called. |
| SetShowingAll | When set to true, removes any search restriction that exists. This call has no effect until "RefreshDisplayList()" is called. |
| SetStartCount | Set the start count (starting at 1) to use when fetching Best Bets. This call has no effect until "RefreshDisplayList()" is called. |
| UpdateBestBet | Update an existing Best Bet. This call will throw an exception if called by anyone but the administrator. |
See Also
IPTSearchBestBetMaintenance Interface | com.plumtree.server.search.admin Namespace