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.progmodel.facets.object.disabled;
021
022import org.apache.isis.core.metamodel.facetapi.Facet;
023import org.apache.isis.core.metamodel.facetapi.FacetHolder;
024import org.apache.isis.core.metamodel.facets.object.immutable.ImmutableFacet;
025import org.apache.isis.core.metamodel.interactions.DisablingInteractionAdvisor;
026import org.apache.isis.core.metamodel.spec.ObjectSpecification;
027import org.apache.isis.core.metamodel.spec.feature.ObjectMember;
028
029/**
030 * Mechanism for determining whether this object should be disabled.
031 * 
032 * <p>
033 * Even though all the properties of an object may themselves be enabled, there
034 * could be reasons to disable the object.
035 * 
036 * <p>
037 * In the standard Apache Isis Programming Model, typically corresponds to the
038 * <tt>disabled</tt> method.
039 * 
040 * @see ImmutableFacet
041 */
042public interface DisabledObjectFacet extends Facet, DisablingInteractionAdvisor {
043
044    /**
045     * Clone this facet onto another {@link FacetHolder}.
046     * 
047     * <p>
048     * Introduced to allow this facet to be installed onto the
049     * {@link ObjectSpecification}, and then copied down onto each of the spec's
050     * {@link ObjectMember}s.
051     */
052    public void copyOnto(FacetHolder holder);
053
054}