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.properties.defaults;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023import org.apache.isis.core.metamodel.facetapi.Facet;
024import org.apache.isis.core.metamodel.facets.object.callbacks.CreatedCallbackFacet;
025
026/**
027 * Provides a default value for a property of a newly created object.
028 * 
029 * <p>
030 * In the standard Apache Isis Programming Model, corresponds to the
031 * <tt>defaultXxx</tt> supporting method for the property with accessor
032 * <tt>getXxx</tt>.
033 * 
034 * <p>
035 * Note: an alternative mechanism may be to specify the value in the created
036 * callback.
037 * 
038 * @see CreatedCallbackFacet
039 */
040public interface PropertyDefaultFacet extends Facet {
041
042    /**
043     * The default value for this property in a newly created object.
044     */
045    public ObjectAdapter getDefault(ObjectAdapter inObject);
046}