net.ontopia.topicmaps.webed.impl.basic.ActionForwardPageIF Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontopia-webed Show documentation

Ontopia Webed.

There is a newer version: 5.4.0

/*
 * #!
 * Ontopia Webed
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * !#
 */

package net.ontopia.topicmaps.webed.impl.basic;

import java.util.Map;

/**
 * INTERNAL: Interface for the description of a forward page assigned
 * to an action.
 */
public interface ActionForwardPageIF {

  /**
   * INTERNAL: Gets the URL to forward to.
   */
  public String getURL();

  /**
   * INTERNAL: Gets the name of the frame which the forwarded page should
   * appear in.
   */
  public String getFramename();

  /**
   * INTERNAL: Adds a request parameter (name, value) pair which should
   * be included when setting up the next request.
   */
  public void addParameter(String paramName, String paramValue);

  /**
   * INTERNAL: Gets all existing request parameter (name, value) pairs.
   *
   * @return Map containing parameter name (String object) as key
   *         and parameter value (String object) as value.
   */
  public Map getParameters();
  
  /**
   * INTERNAL: Gets name of the template for the request parameter which
   * identifies the next action. May be making use of name patterns
   * with the help of placeholders.
   */
  public String getNextActionTemplate();
  
  /**
   * INTERNAL: Get the rule for processing the request parameter
   * handling with the current action name and constructing the next
   * action request parameter with the help of the next action
   * template.
   *
   *  Note: If no specific rule was setup the next
   * action will be identical to the next action template
   */
  public ParamRuleIF getNextActionParamRule();
  
}