de.iwes.widgets.api.extended.pattern.ContextPatternWidget Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of widget-extended Show documentation

The newest version!

/**
 * Copyright 2014-2018 Fraunhofer-Gesellschaft zur Förderung der angewandten Wissenschaften e.V.
 *
 * 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 de.iwes.widgets.api.extended.pattern;

import org.ogema.core.resourcemanager.pattern.ContextSensitivePattern;

import de.iwes.widgets.api.widgets.sessionmanagement.OgemaHttpRequest;

/**
 * A widget that displays all patterns of type P; the pattern type is the same 
 * for all users, but the context may differ, so that different users may see different pattern matches.
 * @see ContextSensitivePattern
 *
 * @param  pattern type
 * @param  context type
 */
public interface ContextPatternWidget
,C> extends PatternWidget {
	
	/**
	 * Get the pattern context for the specified session/request.
	 * @see ContextSensitivePattern
	 * @param req
	 * @return
	 */
	C getContext(OgemaHttpRequest req);
	
	/**
	 * @see #getContext(OgemaHttpRequest)
	 * @param context
	 * @param req
	 */
	void setContext(C context, OgemaHttpRequest req);
	
	/**
	 * @see #getContext(OgemaHttpRequest)
	 * @param context
	 */
	void setDefaultContext(C context);

}