er.modern.look.pages

Class ERMODEditRelationshipPage

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

com.webobjects.directtoweb.D2WComponent

com.webobjects.directtoweb.D2WPage

er.directtoweb.pages.ERD2WPage

er.modern.look.pages.ERMODEditRelationshipPage

All Implemented Interfaces:

WOActionResults, com.webobjects.directtoweb.EditRelationshipPageInterface, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.SelectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERDBranchInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, ERMEditRelationshipPageInterface, Serializable, Cloneable

public class ERMODEditRelationshipPage
extends ERD2WPage
implements ERMEditRelationshipPageInterface, com.webobjects.directtoweb.SelectPageInterface

An improved EditRelationshipPage that supports embedding and inline editing tasks.

See Also:

Serialized Form

Author:

davidleber

D2W Keys

Name	Description
editConfigurationName	editConfigurationName
isEntityEditable	isEntityEditable
checkSortOrderingKeys	checkSortOrderingKeys
defaultSortOrdering	defaultSortOrdering
readOnly	readOnly
relationshipRestrictingQualifier	- An additional qualifier that can be used to restrict the objects shown in the relationship (see: ERDDelayedExtraQualifierAssignment). Useful if you have a value like: isDeleted that you wish to respect.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERMODEditRelationshipPage.Keys

Nested classes/interfaces inherited from class er.directtoweb.pages.ERD2WPage

ERD2WPage.ValidationDelegate

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isRelationshipToMany
WOComponent	nextPage
com.webobjects.directtoweb.NextPageDelegate	nextPageDelegate

Fields inherited from class er.directtoweb.pages.ERD2WPage

_allConfigurations, _branch, _context, _nextPage, _nextPageDelegate, _pageController, _userInfo, errorKeyOrder, errorMessage, errorMessages, keyPathsWithValidationExceptions, log, validationDelegate, validationDelegateInited, validationLog

Fields inherited from class com.webobjects.directtoweb.D2WComponent

_eo, _localContext, currentObjectKey

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERMODEditRelationshipPage(WOContext context)

Method Summary

Modifier and Type	Method and Description
void	awake() Overridden to lock the page's editingContext, if there is any present.
boolean	checkSortOrderingKeys() Returns whether or not sort orderings should be validated (based on the checkSortOrderingKeys rule).
EODataSource	dataSource() DataSource for the relationship.
boolean	displayEditList() Controls whether the edit list page is displayed.
boolean	displayList() Controls whether the inline list page is displayed.
boolean	displayNew() Controls whether the inline eidt/create page is displayed.
boolean	displayQuery() Controls whether the inline query page is displayed.
WOComponent	displayQueryAction() Perform the displayQueryAction.
WOComponent	editListAction() Turn the list repetition into an editable list, to allow simultaneous editing of all objects.
EODataSource	editListDataSource() The data source for the edit list uses a nested EC, so the relationship page's cancel button remains functional.
String	idForRepetitionContainer()
String	inlineTask()
String	inspectConfiguration() Returns the name of the current inline page configuration
boolean	isEntityCreatable() Should the 'new' button be displayed?
boolean	isListEmpty() Checks if the current list is empty.
boolean	isRelationshipOwned()
protected boolean	isValidSortKey(NSArray<String> displayPropertyKeys, String sortKey) Validates the given sort key (is it a display key, an attribute, or a valid attribute path).
int	listSize() The number of objects in the list.
EOEnterpriseObject	masterObject()
NSArray<?>	masterObjectAndRelationshipKey() Returns an array containing the master object (index 0) and relationship key (index 1).
WOComponent	newObjectAction() Performs the newObjectAction.
int	numberOfObjectsPerBatch()
EOEnterpriseObject	objectToAddToRelationship()
WOComponent	queryAction() Performs the queryAction.
void	relatedObjectDidChange(NSNotification notif) Called when an ERMDActionButton changes the related object.
WODisplayGroup	relationshipDisplayGroup() Display group for the related objects
String	relationshipKey()
WOComponent	returnAction() Perform the returnAction.
WOComponent	saveAction() Performs the saveAction.
WOComponent	selectAction() Perform the selectAction.
EODataSource	selectDataSource()
EOEnterpriseObject	selectedObject() Returns the current selected Object.
void	setDataSource(EODataSource ds)
void	setInlineTask(String task)
void	setInlineTaskSafely(String task)
void	setMasterObject(EOEnterpriseObject masterObject)
void	setMasterObjectAndRelationshipKey(EOEnterpriseObject eo, String relationshipKey) Set the master object and relationship key.
void	setMasterObjectAndRelationshipKey(NSArray<?> a) Sets the master object and relationship key.
void	setObjectToAddToRelationship(EOEnterpriseObject objectToAddTorRelationship)
void	setRelationshipDisplayGroup(WODisplayGroup relationshipDisplayGroup)
void	setRelationshipKey(String key)
void	setSelectDataSource(EODataSource selectDataSource)
void	setSelectedObject(EOEnterpriseObject eo) Sets the current selected Object.
void	setSubTaskSafely(String subTask)
NSDictionary<String,Object>	settings()
Boolean	shouldShowEditListButton()
boolean	shouldShowQueryRelatedButton()
Boolean	showBottomActionBlock()
void	sleep() Overridden to unlock the page's editingContext, if there is any present.
NSArray<EOSortOrdering>	sortOrderings()
String	subTask()
boolean	userPreferencesCanSpecifySorting()

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, appendToResponse, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, clickToOpenEnabled, cssClassForPageContainerElement, cssClassForPropertyKey, cssClassForPropertyName, currentSection, currentSectionKeys, currentTab, d2wComponentNameDebuggingEnabled, d2wContext, d2wCurrentComponentName, d2wDebuggingEnabled, descriptionForResponse, displayVariant, editingContext, errorKeyOrder, errorMessage, errorMessageForPropertyKey, errorMessages, hasActualChanges, hasBranchChoices, hasErrors, hasValidationExceptionForPropertyKey, inlineStyleDeclarationForPropertyKey, inlineStyleDeclarationForPropertyName, invokeAction, isEmbedded, isEntityEditable, isEntityReadOnly, isKeyOmitted, isObjectDeleteable, isObjectEditable, isObjectInspectable, isTopLevelPage, latestEntryForCurrentPropertyKey, makeStatsKey, nextPage, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setObject, setPageController, setValidationDelegate, shouldCollectValidationExceptions, shouldDisplayDetailedPageMetrics, shouldDisplayPageMetricsSummary, shouldPropagateExceptions, shouldSetFailedValidationValue, showCancel, statsForPage, statsKeyForCurrentPropertyKey, statsKeyPrefix, tabSectionsContents, tabSectionsContentsFromRuleResult, takeValuesFromRequest, urlForCurrentState, userInfo, userPreferencesValueForKey, userPreferencesValueForPageConfigurationKey, validationDelegate, validationFailedWithException

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, extraBindings, replacementAssociationForAssociation, setExtraBindings

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webobjects.directtoweb.EditRelationshipPageInterface

setNextPage, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.SelectPageInterface

nextPageDelegate, setNextPageDelegate

Field Detail

isRelationshipToMany

public boolean isRelationshipToMany

nextPage

public WOComponent nextPage

nextPageDelegate

public com.webobjects.directtoweb.NextPageDelegate nextPageDelegate

Constructor Detail

ERMODEditRelationshipPage

public ERMODEditRelationshipPage(WOContext context)

Method Detail

awake

public void awake()

Description copied from class: ERD2WPage

Overridden to lock the page's editingContext, if there is any present.

Overrides:

awake in class ERD2WPage

sleep

public void sleep()

Description copied from class: ERD2WPage

Overridden to unlock the page's editingContext, if there is any present.

Overrides:

sleep in class ERD2WPage

displayQueryAction

public WOComponent displayQueryAction()

Perform the displayQueryAction. Sets the inline task to 'query'.

newObjectAction

public WOComponent newObjectAction()

Performs the newObjectAction. Creates a new object and sets the inline task to 'create'

editListAction

public WOComponent editListAction()

Turn the list repetition into an editable list, to allow simultaneous editing of all objects.

editListDataSource

public EODataSource editListDataSource()

The data source for the edit list uses a nested EC, so the relationship page's cancel button remains functional.

Returns:

a data source for the embedded edit list

queryAction

public WOComponent queryAction()

Performs the queryAction. Sets the inline task to 'list'

saveAction

public WOComponent saveAction()

Performs the saveAction. Called by inline edit or create pages.

selectAction

public WOComponent selectAction()

Perform the selectAction. Called by inline select page.

returnAction

public WOComponent returnAction()

Perform the returnAction. Called when the page is a non embedded page is returning to the originating edit page.

relatedObjectDidChange

public void relatedObjectDidChange(NSNotification notif)

Called when an ERMDActionButton changes the related object. Forces the displayGroup to fetch.

displayQuery

public boolean displayQuery()

Controls whether the inline query page is displayed.

displayNew

public boolean displayNew()

Controls whether the inline eidt/create page is displayed.

displayList

public boolean displayList()

Controls whether the inline list page is displayed.

displayEditList

public boolean displayEditList()

Controls whether the edit list page is displayed.

inspectConfiguration

public String inspectConfiguration()

Returns the name of the current inline page configuration

selectedObject

public EOEnterpriseObject selectedObject()

Returns the current selected Object. Required by the SelectPageInterface

Specified by:

selectedObject in interface com.webobjects.directtoweb.SelectPageInterface

setSelectedObject

public void setSelectedObject(EOEnterpriseObject eo)

Sets the current selected Object. Required by the SelectPageInterface

Specified by:

setSelectedObject in interface com.webobjects.directtoweb.SelectPageInterface

masterObjectAndRelationshipKey

public NSArray<?> masterObjectAndRelationshipKey()

Returns an array containing the master object (index 0) and relationship key (index 1). Required by the ERMEditRelationshipPageInterface

Specified by:

masterObjectAndRelationshipKey in interface ERMEditRelationshipPageInterface

Returns:

NSArray containing the master object (index 0) and relationship key (index 1).

setMasterObjectAndRelationshipKey

public void setMasterObjectAndRelationshipKey(NSArray<?> a)

Sets the master object and relationship key. Takes an NSArray containing the master object (index 0) and relationship key (index 1). Required by the ERMEditRelationshipPageInterface

Specified by:

setMasterObjectAndRelationshipKey in interface ERMEditRelationshipPageInterface

Parameters:

a - an NSArray containing the master object (index 0) and relationship key (index 1).

setMasterObjectAndRelationshipKey

public void setMasterObjectAndRelationshipKey(EOEnterpriseObject eo,
                                              String relationshipKey)

Set the master object and relationship key.

Specified by:

setMasterObjectAndRelationshipKey in interface com.webobjects.directtoweb.EditRelationshipPageInterface

Parameters:

eo - the master object, an EOEnterpriseObject

relationshipKey -

settings

public NSDictionary<String,Object> settings()

Overrides:

settings in class ERD2WPage

sortOrderings

public NSArray<EOSortOrdering> sortOrderings()

checkSortOrderingKeys

public boolean checkSortOrderingKeys()

Returns whether or not sort orderings should be validated (based on the checkSortOrderingKeys rule).

Returns:

whether or not sort orderings should be validated

isValidSortKey

protected boolean isValidSortKey(NSArray<String> displayPropertyKeys,
                                 String sortKey)

Validates the given sort key (is it a display key, an attribute, or a valid attribute path).

Parameters:

displayPropertyKeys - the current display properties

sortKey - the sort key to validate

Returns:

true if the sort key is valid, false if not

userPreferencesCanSpecifySorting

public boolean userPreferencesCanSpecifySorting()

numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

Returns:

the batch size as set via ERCPreference or the rules

inlineTask

public String inlineTask()

subTask

public String subTask()

setInlineTask

public void setInlineTask(String task)

setInlineTaskSafely

public void setInlineTaskSafely(String task)

setSubTaskSafely

public void setSubTaskSafely(String subTask)

relationshipKey

public String relationshipKey()

setRelationshipKey

public void setRelationshipKey(String key)

dataSource

public EODataSource dataSource()

DataSource for the relationship.

Overrides:

dataSource in class D2WPage

Returns:

EODataSource an EODetailDataSource created from the masterObject and relationshipKey.

setDataSource

public void setDataSource(EODataSource ds)

Specified by:

setDataSource in interface com.webobjects.directtoweb.SelectPageInterface

Overrides:

setDataSource in class ERD2WPage

objectToAddToRelationship

public EOEnterpriseObject objectToAddToRelationship()

setObjectToAddToRelationship

public void setObjectToAddToRelationship(EOEnterpriseObject objectToAddTorRelationship)

relationshipDisplayGroup

public WODisplayGroup relationshipDisplayGroup()

Display group for the related objects

Returns:

WODisplayGroup lazily instantiated display group.

setRelationshipDisplayGroup

public void setRelationshipDisplayGroup(WODisplayGroup relationshipDisplayGroup)

selectDataSource

public EODataSource selectDataSource()

setSelectDataSource

public void setSelectDataSource(EODataSource selectDataSource)

masterObject

public EOEnterpriseObject masterObject()

setMasterObject

public void setMasterObject(EOEnterpriseObject masterObject)

isListEmpty

public boolean isListEmpty()

Checks if the current list is empty.

listSize

public int listSize()

The number of objects in the list.

isEntityCreatable

public boolean isEntityCreatable()

Should the 'new' button be displayed?

shouldShowQueryRelatedButton

public boolean shouldShowQueryRelatedButton()

isRelationshipOwned

public boolean isRelationshipOwned()

idForRepetitionContainer

public String idForRepetitionContainer()

Returns:

a unique ID for the repetition container

showBottomActionBlock

public Boolean showBottomActionBlock()

shouldShowEditListButton

public Boolean shouldShowEditListButton()

Returns:

true if the list is not empty and shouldShowEditListButton is true