StateScope.java

/**
 * Copyright 2005-2016 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.scope;

import org.hdiv.context.RequestContextHolder;
import org.hdiv.state.IState;

/**
 * <p>
 * Scoped state manager of a specific type.
 * </p>
 * <p>
 * Manages state addition, restore and automatic deletion.
 * </p>
 * 
 * @since 2.1.7
 */
public interface StateScope {

	String addState(RequestContextHolder context, IState state, String token);

	IState restoreState(RequestContextHolder context, int stateId);

	String getStateToken(RequestContextHolder context, int stateId);

	StateScopeType getScopeType();

	boolean isScopeState(String stateId);
}