/*
* #!
* Ontopia Navigator
* #-
* 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.nav.context;
import net.ontopia.topicmaps.core.TopicIF;
import net.ontopia.topicmaps.core.TopicMapIF;
/**
* Interface for defining a method which filters out themes
* which are not relevant to the user context.
*/
public interface UserThemeFilterIF {
/**
* Process theme and find out if it belongs to the user context and
* should therefore be used for configuration.
*
* @return boolean: true if this theme should not be displayed
* for user context configuration
*/
public boolean shouldNotBeUsed(TopicIF actTheme);
/**
* gets TopicMapIF object
*/
public TopicMapIF getTopicMap();
/**
* set TopicMapIF object
*/
public void setTopicMap(TopicMapIF topicMap);
}