ERD2WEditRelationshipPage.java

//
// ERD2WEditRelationshipPage.java
// Project ERDirectToWeb
//
// Created by bposokho on Wed Jul 24 2002
//

package er.directtoweb.pages;

import com.webobjects.appserver.WOComponent;
import com.webobjects.appserver.WOContext;
import com.webobjects.directtoweb.D2W;
import com.webobjects.directtoweb.D2WEditRelationshipPage;
import com.webobjects.directtoweb.EditPageInterface;
import com.webobjects.directtoweb.Services;
import com.webobjects.eoaccess.EOUtilities;
import com.webobjects.eocontrol.EODetailDataSource;
import com.webobjects.eocontrol.EOEditingContext;
import com.webobjects.eocontrol.EOEnterpriseObject;

import er.extensions.eof.ERXEC;
import er.extensions.foundation.ERXValueUtilities;

/**
 * @d2wKey editConfigurationName
 * @d2wKey isEntityEditable
 * @d2wKey readOnly
 */
public class ERD2WEditRelationshipPage extends D2WEditRelationshipPage {
	/**
	 * Do I need to update serialVersionUID?
	 * See section 5.6 <cite>Type Changes Affecting Serialization</cite> on page 51 of the 
	 * <a href="http://java.sun.com/j2se/1.4/pdf/serial-spec.pdf">Java Object Serialization Spec</a>
	 */
	private static final long serialVersionUID = 1L;

    /** interface for all the keys used in this pages code */
    public static interface Keys {
        public static final String isEntityEditable = "isEntityEditable";
        public static final String readOnly = "readOnly";
    }

    private String _relationshipKey;

    /**
     * Public constructor
     * @param c current context
     */
    public ERD2WEditRelationshipPage(WOContext c) {
        super(c);
    }

    /**
     * Overridden because the action bound should not return null.
     */
    @Override
    public WOComponent queryAction() {
        WOComponent nextPage = super.queryAction();
        if(nextPage == null) {
            nextPage = context().page();
        }
        return nextPage;
    }
    
    /**
     * Overridden because the action bound should not return null.
     */
    @Override
    public WOComponent selectAction() {
        WOComponent nextPage = super.selectAction();
        if (ERXValueUtilities.booleanValueWithDefault(d2wContext().valueForKey("returnOnSelect"), false)) {
        	nextPage = returnAction();
        }
        if(nextPage == null) {
            nextPage = context().page();
        }
        return nextPage;
    }
    
    public WOComponent editObjectInRelationship(){
        WOComponent result = null;
        if(browserSelections != null && browserSelections.count() == 1) {
            String editConfigurationName = (String)d2wContext().valueForKey("editConfigurationName");
            EditPageInterface epi;
            if(editConfigurationName != null && editConfigurationName.length() > 0) {
                epi = (EditPageInterface)D2W.factory().pageForConfigurationNamed(editConfigurationName,session());
            } else {
                epi = D2W.factory().editPageForEntityNamed(object().entityName(),session());
            }            
            EOEnterpriseObject eo = (EOEnterpriseObject)browserSelections.objectAtIndex(0);
            epi.setObject(eo);
            epi.setNextPage(context().page());
            result = (WOComponent)epi;
        }
        return result;
    }
    
    @Override
    public void setMasterObjectAndRelationshipKey(EOEnterpriseObject eo, String relationshipKey) {
        EOEditingContext ec = ERXEC.newEditingContext(eo.editingContext(), false); // no validation;
        setEditingContext(ec);
        EOEnterpriseObject localEO = EOUtilities.localInstanceOfObject(ec, eo);
        setObject(localEO);
        _relationshipKey = relationshipKey; 
        if (object().isToManyKey(relationshipKey))
            isRelationshipToMany = true;
        else
            relationshipDisplayGroup.setSelectsFirstObjectAfterFetch(true);
        EODetailDataSource ds = new EODetailDataSource(object().classDescription(), _relationshipKey);
        ds.qualifyWithRelationshipKey(_relationshipKey, localEO);
        setDataSource(ds);
        relationshipDisplayGroup.setDataSource(ds);
        relationshipDisplayGroup.fetch();
        setPropertyKey(displayKey());
    }

    @Override
    public String displayNameForRelationshipKey() {
        return Services.capitalize(_relationshipKey);
    }

    @Override
    public WOComponent removeFromToOneRelationshipAction() {
        dataSource().deleteObject(object().valueForKeyPath(_relationshipKey));
        relationshipDisplayGroup.fetch();
        return null;
    }
    
    /** 
     * Checks if the entity is read-only, meaning that you can't edit its objects.
     *
     * Three factors influence this evaluation:
     * <ol>
     *  <li>The default implementation of {@link com.webobjects.directtoweb.D2WComponent#isEntityReadOnly isEntityReadOnly}</li>
     *  <li>The value of the <code>isEntityEditable</code> rule from the D2WContext.</li>
     *  <li>The value of the <code>readOnly</code> rule from the D2WContext (with no rule-engine inference).</li>
     * </ol>
     *
     * Use <code>isEntityEditable</code> or <code>readOnly</code> rules to override the default behavior.
     *
     * @return true if the entity is considered read-only
     */
    @Override
    public boolean isEntityReadOnly() {
        boolean flag = super.isEntityReadOnly(); // First, check super's implementation.
        
        // Check isEntityEditable.  Use ! because isReadOnly and isEditable are mutually exclusive.
        flag = !ERXValueUtilities.booleanValueWithDefault(d2wContext().valueForKey(Keys.isEntityEditable), !flag);
        
        // Check readOnly.
        // Need no inference else context computes value by querying super's method isEntityReadOnly again.
        flag = ERXValueUtilities.booleanValueWithDefault(d2wContext().valueForKeyNoInference(Keys.readOnly), flag);
        
        return flag;
    }
    
}