/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.isis.core.metamodel.facets.properties.interaction;
import org.apache.isis.applib.events.UsabilityEvent;
import org.apache.isis.applib.events.ValidityEvent;
import org.apache.isis.applib.events.VisibilityEvent;
import org.apache.isis.applib.services.eventbus.AbstractInteractionEvent;
import org.apache.isis.applib.services.eventbus.PropertyInteractionEvent;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.facetapi.FacetHolder;
import org.apache.isis.core.metamodel.facets.InteractionHelper;
import org.apache.isis.core.metamodel.facets.SingleClassValueFacetAbstract;
import org.apache.isis.core.metamodel.facets.propcoll.accessor.PropertyOrCollectionAccessorFacet;
import org.apache.isis.core.metamodel.interactions.ProposedHolder;
import org.apache.isis.core.metamodel.interactions.UsabilityContext;
import org.apache.isis.core.metamodel.interactions.ValidityContext;
import org.apache.isis.core.metamodel.interactions.VisibilityContext;
import org.apache.isis.core.metamodel.runtimecontext.ServicesInjector;
import org.apache.isis.core.metamodel.spec.SpecificationLoader;
public abstract class PropertyInteractionFacetAbstract
extends SingleClassValueFacetAbstract implements PropertyInteractionFacet {
private final InteractionHelper interactionHelper;
final static ThreadLocal<PropertyInteractionEvent<?,?>> currentInteraction = new ThreadLocal<PropertyInteractionEvent<?,?>>();
private final PropertyOrCollectionAccessorFacet getterFacet;
public PropertyInteractionFacetAbstract(
final Class<? extends PropertyInteractionEvent<?, ?>> eventType,
final PropertyOrCollectionAccessorFacet getterFacet,
final FacetHolder holder,
final ServicesInjector servicesInjector,
final SpecificationLoader specificationLoader) {
super(PropertyInteractionFacet.class, holder, eventType, specificationLoader);
this.getterFacet = getterFacet;
interactionHelper = new InteractionHelper(servicesInjector);
}
@Override
public String hides(VisibilityContext<? extends VisibilityEvent> ic) {
if(!interactionHelper.hasEventBusService()) {
return null;
}
// reset (belt-n-braces)
currentInteraction.set(null);
final PropertyInteractionEvent<?, ?> event =
interactionHelper.postEventForProperty(
eventType(), null, AbstractInteractionEvent.Phase.HIDE, getIdentified(), ic.getTarget(), null, null);
if (event != null && event.isHidden()) {
return "Hidden by subscriber";
}
return null;
}
@Override
public String disables(UsabilityContext<? extends UsabilityEvent> ic) {
if(!interactionHelper.hasEventBusService()) {
return null;
}
// reset (belt-n-braces)
currentInteraction.set(null);
final PropertyInteractionEvent<?, ?> event =
interactionHelper.postEventForProperty(
eventType(), null, AbstractInteractionEvent.Phase.DISABLE, getIdentified(), ic.getTarget(), null, null);
if (event != null && event.isDisabled()) {
return event.getDisabledReason();
}
return null;
}
@Override
public String invalidates(ValidityContext<? extends ValidityEvent> ic) {
if(!interactionHelper.hasEventBusService()) {
return null;
}
// reset (belt-n-braces)
currentInteraction.set(null);
final Object oldValue = getterFacet.getProperty(ic.getTarget());
final Object proposedValue = proposedFrom(ic);
final PropertyInteractionEvent<?, ?> event =
interactionHelper.postEventForProperty(
eventType(), null, AbstractInteractionEvent.Phase.VALIDATE, getIdentified(), ic.getTarget(), oldValue, proposedValue);
if (event != null && event.isInvalid()) {
return event.getInvalidityReason();
}
// make available for next phases (executing/executed)
currentInteraction.set(event);
return null;
}
private static Object proposedFrom(ValidityContext<? extends ValidityEvent> ic) {
final ProposedHolder ph = (ProposedHolder) ic;
final ObjectAdapter proposedAdapter = ph.getProposed();
return proposedAdapter != null? proposedAdapter.getObject(): null;
}
private Class<?> eventType() {
return value();
}
}