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    
020    package org.apache.isis.core.progmodel.facets.members.hide;
021    
022    import org.apache.isis.applib.events.VisibilityEvent;
023    import org.apache.isis.core.metamodel.facetapi.Facet;
024    import org.apache.isis.core.metamodel.facetapi.FacetAbstract;
025    import org.apache.isis.core.metamodel.facetapi.FacetHolder;
026    import org.apache.isis.core.metamodel.interactions.VisibilityContext;
027    
028    /**
029     * Hide a property, collection or action based on the current session.
030     * 
031     * <p>
032     * In the standard Apache Isis Programming Model, corresponds to invoking the <tt>hideXxx(UserMemento)</tt> support
033     * method for the member.
034     */
035    public abstract class HideForSessionFacetAbstract extends FacetAbstract implements HideForSessionFacet {
036    
037        public static Class<? extends Facet> type() {
038            return HideForSessionFacet.class;
039        }
040    
041        public HideForSessionFacetAbstract(final FacetHolder holder) {
042            super(type(), holder, false);
043        }
044    
045        @Override
046        public String hides(final VisibilityContext<? extends VisibilityEvent> ic) {
047            return hiddenReason(ic.getSession());
048        }
049    }