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 */
019package org.apache.isis.extensions.secman.api.permission;
020
021import org.apache.isis.commons.internal.base._Strings;
022import org.apache.isis.core.metamodel.services.appfeat.ApplicationFeature;
023
024/**
025 * Whether the permission {@link #ALLOW grants} or {@link #VETO denies} access to an
026 * {@link ApplicationFeature}.
027 */
028public enum ApplicationPermissionRule {
029    /**
030     * The permission grants the ability to view/use the {@link ApplicationFeature}.
031     *
032     * <p>
033     * The {@link ApplicationPermissionMode mode} determines whether the
034     * permission is to only view or also to use the {@link ApplicationFeature}.
035     * </p>
036     */
037    ALLOW,
038    /**
039     * The permission prevents the ability to view/use the {@link ApplicationFeature}.
040     *
041     * <p>
042     * The {@link ApplicationPermissionMode mode} determines whether the
043     * permission is to only view or also to use the {@link ApplicationFeature}.
044     * </p>
045     */
046    VETO;
047
048    @Override
049    public String toString() {
050        return _Strings.capitalize(name());
051    }
052}