001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019package lucee.runtime.cfx.customtag;
020
021import lucee.runtime.cfx.CFXTagException;
022
023import com.allaire.cfx.CustomTag;
024
025/**
026 * interface for a CustomTag Class, a CustomTag Class is Base to generate a Custom Tag
027 */
028public interface CFXTagClass {
029        
030        
031        /**
032         * @return return a New Instance
033         * @throws CFXTagException
034         */
035        public CustomTag newInstance() throws CFXTagException;
036        
037        /**
038         * @return returns if Tag is readOnly (for Admin)
039         */
040        public boolean isReadOnly();
041
042        /**
043         * @return returns a readonly copy of the tag
044         */
045        public CFXTagClass cloneReadOnly();
046        
047        /**
048         * @return returns Type of the CFX Tag as String
049         */
050        public String getDisplayType();
051        
052        /**
053         * @return returns the Source Name as String 
054         */
055        public String getSourceName();
056
057    /**
058     * @return returns if tag is ok
059     */
060    public boolean isValid();
061}