001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.interactions;
021
022import static org.apache.isis.core.metamodel.adapter.util.AdapterUtils.unwrap;
023
024import org.apache.isis.applib.Identifier;
025import org.apache.isis.applib.events.PropertyModifyEvent;
026import org.apache.isis.core.commons.authentication.AuthenticationSession;
027import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
028import org.apache.isis.core.metamodel.consent.InteractionContextType;
029import org.apache.isis.core.metamodel.consent.InteractionInvocationMethod;
030import org.apache.isis.core.metamodel.deployment.DeploymentCategory;
031
032/**
033 * See {@link InteractionContext} for overview; analogous to
034 * {@link PropertyModifyEvent}.
035 */
036public class PropertyModifyContext extends ValidityContext<PropertyModifyEvent> implements ProposedHolder {
037
038    private final ObjectAdapter proposed;
039
040    public PropertyModifyContext(DeploymentCategory deploymentCategory, final AuthenticationSession session, final InteractionInvocationMethod invocationMethod, final ObjectAdapter target, final Identifier id, final ObjectAdapter proposed) {
041        super(InteractionContextType.PROPERTY_MODIFY, deploymentCategory, session, invocationMethod, id, target);
042
043        this.proposed = proposed;
044    }
045
046    /**
047     * The (proposed) new value for a property.
048     */
049    @Override
050    public ObjectAdapter getProposed() {
051        return proposed;
052    }
053
054    @Override
055    public PropertyModifyEvent createInteractionEvent() {
056        return new PropertyModifyEvent(unwrap(getTarget()), getIdentifier(), unwrap(getProposed()));
057    }
058
059}