ERDSavedQueriesComponent Class Reference

Inherits com::webobjects::appserver::WOComponent.

Inherited by ERNEUSavedQueriesComponent.

Collaboration diagram for ERDSavedQueriesComponent:

[legend]

List of all members.

Classes
class	_TimestampSupport
interface	RequestParams
class	SavedQuery
Public Member Functions
WOComponent	addNewQuery ()
boolean	autoSubmitEnabled ()
WOComponent	clearForm ()
D2WContext	d2wContext ()
String	defaultQueryNameForPageConfiguration (String pageConfigurationName)
WOComponent	deleteAllSavedQueries ()
WOComponent	deleteCurrentQuery ()
WODisplayGroup	displayGroup ()
	ERDSavedQueriesComponent (WOContext context)
String	fetchSavedQueryResultsLink ()
boolean	hasNoSavedQueries ()
boolean	isDefaultQuery (ERDSavedQueriesComponent.SavedQuery aQuery)
boolean	isNoSelectedQuery ()
boolean	isSelectedQueryTheDefault ()
boolean	isStateless ()
NSMutableArray	loadSavedQueriesForPageConfigurationNamed (String pageConfigurationName)
WOComponent	makeDefaultSavedQuery ()
String	pageConfiguration ()
WOComponent	popupChangedSelection ()
NSDictionary	queryParamsToFetchSavedQueryResults ()
WOComponent	refresh ()
NSMutableArray	savedQueries ()
void	saveQueriesForPageConfigurationNamed (NSArray queries, String pageConfigurationName)
void	setAutoSubmitEnabled (boolean b)
void	setDefaultQueryNameForPageConfiguration (String aName, String pageConfigurationName)
boolean	showBookmarkableQueryResultsLink ()
void	sleep ()
boolean	synchronizesVariablesWithBindings ()
WOComponent	updateCurrentQuery ()
Static Public Member Functions
static NSDictionary	savedQueriesForPageConfigurationNamed (WOSession session, String pageConfigurationName)
static String	userPreferenceNameForAutoSubmitWithPageConfiguration (String pageConfiguration)
static String	userPreferenceNameForDefaultQueryWithPageConfiguration (String pageConfiguration)
static String	userPreferenceNameForPageConfiguration (String pageConfiguration)
Public Attributes
ERDSavedQueriesComponent.SavedQuery	aSavedQuery = null
final String	DEFAULT_QUERY_NONE = ""
boolean	needsAutoSubmit = false
String	newQueryName = null
ERDSavedQueriesComponent.SavedQuery	selectedSavedQuery = null
Static Public Attributes
static final Logger	log = Logger.getLogger(ERDSavedQueriesComponent.class)
static final EOKeyValueArchiving.Support	newEOKVArchiningTimestampSupport = newEOKVArchivingTimestampSupport
static final EOKeyValueArchiving.Support	newEOKVArchivingTimestampSupport = new ERDSavedQueriesComponent._TimestampSupport()
static final EOKeyValueArchiving.Support	originalEOKVArchiningTimestampSupport = originalEOKVArchivingTimestampSupport
static final EOKeyValueArchiving.Support	originalEOKVArchivingTimestampSupport = new EOKeyValueArchiving._TimestampSupport()
Protected Member Functions
NSKeyValueCoding	userPreferences ()
Static Package Functions
static NSKeyValueCoding	userPreferences (WOSession session)
Private Attributes
NSMutableArray	_savedQueries = null
NSKeyValueCoding	_userPreferences = null
Static Private Attributes
static SavedQuery	emptySavedQueryForDeletes = new SavedQuery()

---

Detailed Description

This Component will store the forms values in the displayGroup of a Query Page into user preferences under a saved name. The list of saved queries will be available in the popup for future use.

Preference key = "SavedQueryFor"+pageConfiguration

The ERNEUQueryPage has been modified to switch in the value of the rule keyPath = "savedQueryComponentName" So, if you want this component to appear on your query page, create a rule defining savedQueryComponentName="ERNEUSavedQueriesComponent"

Author:

dscheck

---

Constructor & Destructor Documentation

ERDSavedQueriesComponent

(

WOContext

context

)

---

Member Function Documentation

WOComponent addNewQuery

(

)

boolean autoSubmitEnabled

(

)

WOComponent clearForm

(

)

D2WContext d2wContext

(

)

String defaultQueryNameForPageConfiguration

(

String

pageConfigurationName

)

WOComponent deleteAllSavedQueries

(

)

WOComponent deleteCurrentQuery

(

)

WODisplayGroup displayGroup

(

)

String fetchSavedQueryResultsLink

(

)

For this method to work properly, a valid action should be passed in as a binding for key: directActionNameToFetchSavedQueryResults

Returns:

String - link to the DA which knows how to fetch the query results given the saved query name

boolean hasNoSavedQueries

(

)

boolean isDefaultQuery

(

ERDSavedQueriesComponent.SavedQuery

aQuery

)

boolean isNoSelectedQuery

(

)

boolean isSelectedQueryTheDefault

(

)

boolean isStateless

(

)

component is not stateless

NSMutableArray loadSavedQueriesForPageConfigurationNamed

(

String

pageConfigurationName

)

WOComponent makeDefaultSavedQuery

(

)

String pageConfiguration

(

)

WOComponent popupChangedSelection

(

)

NSDictionary queryParamsToFetchSavedQueryResults

(

)

WOComponent refresh

(

)

NSMutableArray savedQueries

(

)

static NSDictionary savedQueriesForPageConfigurationNamed	(	WOSession	session,
		String	pageConfigurationName
	)			[static]

retrieves the saved queries for the given pageConfiguration and returns a dictionary where the key is the name of the savedQuery and value is the savedQuery itself.

Parameters:

	session	WOSession - to check if there is a session level ERCoreUserPreferences set
	pageConfigurationName	String

Returns:

NSDictionary
key - String name of savedQuery
value - SavedQuery

void saveQueriesForPageConfigurationNamed	(	NSArray	queries,
		String	pageConfigurationName
	)

void setAutoSubmitEnabled

(

boolean

b

)

void setDefaultQueryNameForPageConfiguration	(	String	aName,
		String	pageConfigurationName
	)

boolean showBookmarkableQueryResultsLink

(

)

Returns:

Boolean
true, only if valid named query has been selected and the binding to the key: 'directActionNameToFetchSavedQueryResults' points to a valid directAction
false, otherwise

void sleep

(

)

boolean synchronizesVariablesWithBindings

(

)

component does not synchronize variables

WOComponent updateCurrentQuery

(

)

static String userPreferenceNameForAutoSubmitWithPageConfiguration

(

String

pageConfiguration

)

[static]

static String userPreferenceNameForDefaultQueryWithPageConfiguration

(

String

pageConfiguration

)

[static]

static String userPreferenceNameForPageConfiguration

(

String

pageConfiguration

)

[static]

static NSKeyValueCoding userPreferences

(

WOSession

session

)

[static, package]

NSKeyValueCoding userPreferences

(

)

[protected]

---

Member Data Documentation

NSMutableArray _savedQueries = null [private]

NSKeyValueCoding _userPreferences = null [private]

ERDSavedQueriesComponent.SavedQuery aSavedQuery = null

final String DEFAULT_QUERY_NONE = ""

SavedQuery emptySavedQueryForDeletes = new SavedQuery() [static, private]

final Logger log = Logger.getLogger(ERDSavedQueriesComponent.class) [static]

Reimplemented in ERNEUSavedQueriesComponent.

boolean needsAutoSubmit = false

final EOKeyValueArchiving.Support newEOKVArchiningTimestampSupport = newEOKVArchivingTimestampSupport [static]

Deprecated:

use newEOKVArchivingTimestampSupport

final EOKeyValueArchiving.Support newEOKVArchivingTimestampSupport = new ERDSavedQueriesComponent._TimestampSupport() [static]

String newQueryName = null

final EOKeyValueArchiving.Support originalEOKVArchiningTimestampSupport = originalEOKVArchivingTimestampSupport [static]

Deprecated:

use originalEOKVArchivingTimestampSupport

final EOKeyValueArchiving.Support originalEOKVArchivingTimestampSupport = new EOKeyValueArchiving._TimestampSupport() [static]

ERDSavedQueriesComponent.SavedQuery selectedSavedQuery = null

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/components/misc/ERDSavedQueriesComponent.java