View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one
    3    * or more contributor license agreements.  See the NOTICE file
    4    * distributed with this work for additional information
    5    * regarding copyright ownership.  The ASF licenses this file
    6    * to you under the Apache License, Version 2.0 (the
    7    * "License"); you may not use this file except in compliance
    8    * with the License.  You may obtain a copy of the License at
    9    *
    10   *   http://www.apache.org/licenses/LICENSE-2.0
    11   *
    12   * Unless required by applicable law or agreed to in writing,
    13   * software distributed under the License is distributed on an
    14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15   * KIND, either express or implied.  See the License for the
    16   * specific language governing permissions and limitations
    17   * under the License.
    18   */
    19
    20  package org.apache.myfaces.orchestra.requestParameterProvider;
    21
    22  /**
    23   * The interface a provider has to implement to add parameters to the url.
    24   * <p>
    25   * Objects which need to append parameters to all urls in the page being generated
    26   * should create an implementation of this interface and register an object of that
    27   * type with the RequestParameterProviderManager. When the page is generated the
    28   * manager will call back to every registered RequestParameterProvider to get the
    29   * data it needs to append.
    30   */
    31  public interface RequestParameterProvider
    32  {
    33      /**
    34       * Return the names of fields this instance wants to add to the url. Each value in the
    35       * returned array is then used as a parameter to the getFieldValue method.
    36       */
    37      public String[] getFields();
    38
    39      /**
    40       * Return the value for the given field (which should be one of the values returned
    41       * by the getFields method).
    42       */
    43      public String getFieldValue(String field);
    44  }