oracle.ecsf.client
Class SavedSearchManager

java.lang.Object
  oracle.ecsf.client.SavedSearchManager

public class SavedSearchManager
extends java.lang.Object

Field Summary

protected static java.util.logging.Logger

sLogger

Constructor Summary

protected

SavedSearchManager()

Method Summary

SavedSearch	createSavedSearch(SearchContext ctx, java.lang.String searchName, java.lang.String searchDescription, QueryMetaData queryDetails) Creates a new saved search
SavedSearch	createSavedSearch(SearchContext ctx, java.lang.String searchName, java.lang.String searchDescription, QueryMetaData queryDetails, java.lang.String callerCtx) Creates a new saved search
void	deleteSavedSearch(SearchContext ctx, SavedSearch savedSearch) Deletes the specified Saved Search from the database
void	findAndSetECSFComponentId(SearchContext ctx, SavedSearch savedSearch) find and set the ECSF component ID of a saved search object
static SavedSearchManager	getInstance()
SavedSearch	getSavedSearch(SearchContext ctx, java.lang.String searchName) Returns the SavedSearch object with the specified name
java.util.ArrayList<SavedSearch>	getSavedSearches(SearchContext ctx) Returns an ArrayList of SavedSearch data objects for the current user defined in the SearchContext
java.util.ArrayList<SavedSearch>	getSavedSearches(SearchContext ctx, java.lang.String callerCtx) Returns an ArrayList of SavedSearch data objects for the current user defined in the SearchContext and the specified caller context
void	updateSavedSearch(SearchContext ctx, SavedSearch savedSearch) Updates the saved search table with the info from the specified saved search object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sLogger

protected static java.util.logging.Logger sLogger

Constructor Detail

SavedSearchManager

protected SavedSearchManager()

Method Detail

getInstance

public static SavedSearchManager getInstance()

getSavedSearches

public java.util.ArrayList<SavedSearch> getSavedSearches(SearchContext ctx)
                                                  throws SearchException

Returns an ArrayList of SavedSearch data objects for the current user defined in the SearchContext

Parameters:

ctx - the current SearchContext

Returns:

ArrayList< SavedSearch> list of SavedSearches

Throws:

SearchException

getSavedSearches

public java.util.ArrayList<SavedSearch> getSavedSearches(SearchContext ctx,
                                                         java.lang.String callerCtx)
                                                  throws SearchException

Returns an ArrayList of SavedSearch data objects for the current user defined in the SearchContext and the specified caller context

Parameters:

ctx - the current SearchContext

callerCtx - the caller context

Returns:

ArrayList< SavedSearch> list of SavedSearchs

Throws:

SearchException

getSavedSearch

public SavedSearch getSavedSearch(SearchContext ctx,
                                  java.lang.String searchName)
                           throws SearchException

Returns the SavedSearch object with the specified name

Parameters:

ctx - the current SearchContext

searchName - the name of the saved search

Returns:

SavedSearch SavedSearch data object , null if no search was found

Throws:

SearchException

createSavedSearch

public SavedSearch createSavedSearch(SearchContext ctx,
                                     java.lang.String searchName,
                                     java.lang.String searchDescription,
                                     QueryMetaData queryDetails)
                              throws SearchException

Creates a new saved search

Parameters:

ctx - the SearchContext

searchName - the name of the saved search

searchDescription - the description of the saved search

queryDetails - the saved search query information

Returns:

SavedSearch

Throws:

SearchException

createSavedSearch

public SavedSearch createSavedSearch(SearchContext ctx,
                                     java.lang.String searchName,
                                     java.lang.String searchDescription,
                                     QueryMetaData queryDetails,
                                     java.lang.String callerCtx)
                              throws SearchException

Creates a new saved search

Parameters:

ctx - the SearchContext

searchName - the name of the saved search

searchDescription - the description of the saved search

queryDetails - the saved search query information

callerCtx - the caller context

Returns:

SavedSearch

Throws:

SearchException

updateSavedSearch

public void updateSavedSearch(SearchContext ctx,
                              SavedSearch savedSearch)
                       throws SearchException

Updates the saved search table with the info from the specified saved search object.

Parameters:

ctx - the SearchContext

savedSearch - the updated saved search

Throws:

SearchException

findAndSetECSFComponentId

public void findAndSetECSFComponentId(SearchContext ctx,
                                      SavedSearch savedSearch)
                               throws SearchException

find and set the ECSF component ID of a saved search object

Parameters:

savedSearch -

Throws:

SearchException

deleteSavedSearch

public void deleteSavedSearch(SearchContext ctx,
                              SavedSearch savedSearch)
                       throws SearchException

Deletes the specified Saved Search from the database

Parameters:

ctx - the SearchContext

savedSearch - the Saved Search to delete

Throws:

SearchException