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.object.defaults;
021    
022    import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023    import org.apache.isis.core.metamodel.facets.SingleValueFacet;
024    import org.apache.isis.core.metamodel.facets.actions.defaults.ActionDefaultsFacet;
025    import org.apache.isis.core.metamodel.facets.properties.defaults.PropertyDefaultFacet;
026    
027    /**
028     * Indicates that this class has a default.
029     * 
030     * <p>
031     * The mechanism for providing a default will vary by the applib. In the Java applib, this is done by implementing the
032     * DefaultProvider interface.
033     * 
034     * <p>
035     * The rest of the framework does not used this directly, but instead we infer {@link PropertyDefaultFacet} and
036     * {@link ActionDefaultsFacet} from the method's return type / parameter types, and copy over.
037     */
038    public interface DefaultedFacet extends SingleValueFacet {
039    
040        /**
041         * The default (as a pojo, not a {@link ObjectAdapter}).
042         * 
043         * @return
044         */
045        Object getDefault();
046    }