org.tmapi.core
Interface ScopedObject

All Superinterfaces:

TopicMapObject

All Known Subinterfaces:

Association, Occurrence, TopicName, Variant

public interface ScopedObject

extends TopicMapObject

The base class for all objects which take a collection of topic objects to define a scope or parameter property.

Method Summary

void	addScopingTopic(Topic topic) Adds a topic to the set which define the scope/parameters for this object.
java.util.Set	getScope() Returns the topics which define the scope/parameters of this ScopedObject.
void	removeScopingTopic(Topic topic) Removes a topic from the set which defines the scope/parameters for this object.

Methods inherited from interface org.tmapi.core.TopicMapObject

addSourceLocator, equals, getObjectId, getSourceLocators, getTopicMap, hashCode, remove, removeSourceLocator

Method Detail

getScope

public java.util.Set getScope()

Returns the topics which define the scope/parameters of this ScopedObject. The return value may be an empty Set, but is never null.

Returns:

An unmodifiable Set of Topic objects.

addScopingTopic

public void addScopingTopic(Topic topic)

Adds a topic to the set which define the scope/parameters for this object.

Parameters:

topic - The topic to be added to the set.

removeScopingTopic

public void removeScopingTopic(Topic topic)

Removes a topic from the set which defines the scope/parameters for this object.

Parameters:

topic - The topic to be remove from the set.