/*
* 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.object.hidden;
import org.apache.isis.core.metamodel.facetapi.Facet;
import org.apache.isis.core.metamodel.facetapi.FacetHolder;
import org.apache.isis.core.metamodel.interactions.HidingInteractionAdvisor;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.feature.ObjectMember;
/**
* Mechanism for determining whether this object is should be hidden.
*
* <p>
* Even though all the properties of an object may themselves be visible, there
* could be reasons to hide the object.
* </p>
*
* <p>
* In the standard Apache Isis Programming Model, typically corresponds to the
* <tt>hidden</tt> method.
* </p>
*
* @see org.apache.isis.core.metamodel.facets.all.hide.HiddenFacet
*/
public interface HiddenObjectFacet extends Facet, HidingInteractionAdvisor {
/**
* Clone this facet onto another {@link FacetHolder}.
*
* <p>
* Introduced to allow this facet to be installed onto the
* {@link ObjectSpecification}, and then copied down onto each of the spec's
* {@link ObjectMember}s.
*/
public void copyOnto(FacetHolder holder);
}