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 org.apache.isis.applib.events.VisibilityEvent;
023import org.apache.isis.core.metamodel.facetapi.FacetAbstract.Hiding;
024
025/**
026 * Mix-in interface for facets that can advise as to whether a member should be
027 * hidden.
028 * 
029 * @see DisablingInteractionAdvisor
030 * @see ValidatingInteractionAdvisor
031 */
032public interface HidingInteractionAdvisor extends InteractionAdvisorFacet, Hiding {
033
034    /**
035     * Whether the rule represented by this facet hides the member to which it
036     * applies.
037     * 
038     * <p>
039     * Implementations should use the provided {@link InteractionContext} to
040     * determine whether they declare the object/member is hidden. They must
041     * however guard against a <tt>null</tt>
042     * {@link InteractionContext#getTarget() target} and
043     * {@link InteractionContext#getSession() session} - neither are guaranteed
044     * to be populated.
045     */
046    String hides(final VisibilityContext<? extends VisibilityEvent> ic);
047}