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