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.myfaces.tobago.taglib.decl;
021    
022    import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
023    import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
024    
025    public interface HasLink {
026      /**
027       * Link to an arbitrary URL, either an internal link or an external link.
028    
029       * <dl>
030       *   <dt>internal absolute link</dt>
031       *   <dd>Starts with a slash '/' character. The context path will be added.
032       *       A session id will be added, if needed.</dd>
033       *   <dt>external link</dt>
034       *   <dd>Starts with protocol followed by ':' character.
035       *       The link will not be modified.</dd>
036       *   <dt>internal relative link</dt>
037       *   <dd>Any other strings. A session id will be added, if needed.</dd>
038       * </dl>
039       *
040       * @param link The external or internal link.
041       */
042      @TagAttribute
043      @UIComponentTagAttribute()
044      void setLink(String link);
045    }