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.validprops;
021    
022    import org.apache.isis.core.metamodel.facetapi.Facet;
023    import org.apache.isis.core.metamodel.facets.mandatory.MandatoryFacet;
024    import org.apache.isis.core.metamodel.interactions.ObjectValidityContext;
025    import org.apache.isis.core.metamodel.interactions.ValidatingInteractionAdvisor;
026    
027    /**
028     * Object-level {@link ValidatingInteractionAdvisor validator} that ensures that all {@link MandatoryFacet mandatory}
029     * properties are entered prior to persisting the object.
030     */
031    public interface ObjectValidPropertiesFacet extends Facet, ValidatingInteractionAdvisor {
032    
033        /**
034         * The reason the object is invalid.
035         * 
036         * <p>
037         * . If the object is actually valid, should return <tt>null</tt>.
038         */
039        public String invalidReason(ObjectValidityContext context);
040    
041    }