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.regex;
021    
022    import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
023    import org.apache.isis.core.metamodel.interactions.ValidatingInteractionAdvisor;
024    import org.apache.isis.core.progmodel.facets.object.mask.MaskFacet;
025    
026    /**
027     * Whether the (string) property or a parameter must correspond to a specific regular expression.
028     * 
029     * <p>
030     * In the standard Apache Isis Programming Model, corresponds to the <tt>@RegEx</tt> annotation.
031     * 
032     * @see MaskFacet
033     */
034    public interface RegExFacet extends MultipleValueFacet, ValidatingInteractionAdvisor {
035    
036        public String validation();
037    
038        public String format();
039    
040        public boolean caseSensitive();
041    
042        public boolean doesNotMatch(String proposed);
043    
044        public String format(String text);
045    
046    }