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.facets.actions.command;
021
022import org.apache.isis.applib.annotation.Command.ExecuteIn;
023import org.apache.isis.applib.annotation.Command.Persistence;
024import org.apache.isis.applib.services.command.Command;
025import org.apache.isis.core.metamodel.facetapi.Facet;
026
027/**
028 * Indicates that details of the action should be available as a
029 * {@link Command} object, if possible.
030 * 
031 * <p>
032 * In the standard Apache Isis Programming Model, corresponds to annotating the
033 * action method using <tt>@Command</tt>.
034 */
035public interface CommandFacet extends Facet {
036
037    public Persistence persistence();
038    
039    public ExecuteIn executeIn();
040    
041    /**
042     * Indicates that the action to which this {@link Facet} is
043     * attached should <i>not</i> be treated as an action.
044     * 
045     * <p>
046     * Exists to allow implementations that configure all actions to be treated as 
047     * commands, but which can then be disabled for selected actions (eg using 
048     * {@link org.apache.isis.applib.annotation.Command#disabled()}).
049     */
050    public boolean isDisabled();
051
052}