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.mask;
021    
022    import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023    import org.apache.isis.core.metamodel.facets.SingleStringValueFacet;
024    import org.apache.isis.core.metamodel.interactions.ValidatingInteractionAdvisor;
025    import org.apache.isis.core.progmodel.facets.object.regex.RegExFacet;
026    
027    /**
028     * Whether the (string) property or a parameter must correspond to a specific mask.
029     * 
030     * <p>
031     * In the standard Apache Isis Programming Model, corresponds to the <tt>@Mask</tt> annotation.
032     * 
033     * <p>
034     * TODO: not yet implemented by the framework or any viewer.
035     * 
036     * @see RegExFacet
037     */
038    public interface MaskFacet extends SingleStringValueFacet, ValidatingInteractionAdvisor {
039    
040        /**
041         * Whether the provided string matches the mask.
042         */
043        public boolean doesNotMatch(ObjectAdapter adapter);
044    }