IPage.java

/**
 * Copyright 2005-2010 hdiv.org
 *
 * 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 org.hdiv.state;

import java.util.Map;

public interface IPage {

	/**
	 * Adds a new state to the page <code>this</code>.
	 * 
	 * @param state State that represents all the data that composes a possible
	 *            request.
	 */
	public void addState(IState state);

	/**
	 * Adds a new state hash to the page <code>this</code>.
	 * 
	 * @param id state identifier
	 * @param state Hash of a state that represents all the data that composes a
	 *            possible request.
	 */
	public void addState(String id, String request);

	/**
	 * Checks if exists a state with the given identifier <code>key</code>.
	 * 
	 * @param key State identifier
	 */
	public boolean existState(String key);

	/**
	 * Returns the state with the given identifier <code>key</code> from the
	 * map of states
	 * 
	 * @param key State identifier
	 * @return IState State with the identifier <code>key</code>.
	 */
	public IState getState(String key);

	/**
	 * Returns the state hash with the given identifier <code>key</code> from
	 * the map of states
	 * 
	 * @param key State identifier
	 * @return String hash with the identifier <code>key</code>.
	 */
	public String getStateHash(String key);

	/**
	 * @return Returns the page name.
	 */
	public String getName();

	/**
	 * @param name The page name to set.
	 */
	public void setName(String name);

	/**
	 * @return Returns the page states.
	 */
	public Map getStates();
	
	/**
	 * Returns the unique id of flow.
	 * @return the flow id
	 */
	public String getFlowId();

	/**
	 * @param flowId the flowId to set
	 */
	public void setFlowId(String flowId);

	/**
	 * @return the randomToken
	 * @since HDIV 2.0.4
	 */
	public String getRandomToken();
	
	/**
	 * @param randomToken the randomToken to set
	 * @since HDIV 2.0.4
	 */
	public void setRandomToken(String randomToken);	
}