001    package org.apache.myfaces.tobago.taglib.decl;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one or more
005     * contributor license agreements.  See the NOTICE file distributed with
006     * this work for additional information regarding copyright ownership.
007     * The ASF licenses this file to You under the Apache License, Version 2.0
008     * (the "License"); you may not use this file except in compliance with
009     * the License.  You may obtain a copy of the License at
010     *
011     *      http://www.apache.org/licenses/LICENSE-2.0
012     *
013     * Unless required by applicable law or agreed to in writing, software
014     * distributed under the License is distributed on an "AS IS" BASIS,
015     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016     * See the License for the specific language governing permissions and
017     * limitations under the License.
018     */
019    
020    import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
021    import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
022    
023    public interface HasLink {
024      /**
025       * Link to an arbitrary URL, either an internal link or an external link.
026    
027       * <dl>
028       *   <dt>internal absolute link</dt>
029       *   <dd>Starts with a slash '/' character. The context path will be added.
030       *       A session id will be added, if needed.</dd>
031       *   <dt>external link</dt>
032       *   <dd>Contains a colon ':' character.
033       *       The link will not be modified.</dd>
034       *   <dt>internal relative link</dt>
035       *   <dd>Any other strings. A session id will be added, if needed.</dd>
036       * </dl>
037       *
038       * @param link The external or internal link.
039       */
040      @TagAttribute
041      @UIComponentTagAttribute()
042      void setLink(String link);
043    }