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.members.hidden;
021
022import org.apache.isis.applib.annotation.When;
023import org.apache.isis.applib.annotation.Where;
024import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
025import org.apache.isis.core.metamodel.facetapi.FacetHolder;
026
027public class HiddenFacetImpl extends HiddenFacetAbstract {
028
029    public HiddenFacetImpl(final When when, Where where, final FacetHolder holder) {
030        super(when, where, holder);
031    }
032
033    @Override
034    public String hiddenReason(final ObjectAdapter targetAdapter, Where whereContext) {
035        if(!where().includes(whereContext)) {
036            return null;
037        }
038        
039        if (when() == When.ALWAYS) {
040            return "Always hidden";
041        }
042        if (when() == When.NEVER) {
043            return null;
044        }
045
046        // remaining tests depend on target in question.
047        if (targetAdapter == null) {
048            return null;
049        }
050
051        if (when() == When.UNTIL_PERSISTED) {
052            return targetAdapter.isTransient() ? "Hidden until persisted" : null;
053        } else if (when() == When.ONCE_PERSISTED) {
054            return targetAdapter.representsPersistent() ? "Hidden once persisted" : null;
055        }
056        return null;
057    }
058
059}