de.tif.jacob.core.definition
Interface IRelationSet

All Superinterfaces:

INamedObjectDefinition

public interface IRelationSet
extends INamedObjectDefinition

This interface represents a relation set. Relation sets are used to restrict existing QBE constrains then performing a query on a IDataBrowser. Additionally they are used to determine how far a record propagation should be executed. See IDataAccessor.propagateRecord(IDataRecord, IRelationSet, Filldirection).

Field Summary

static java.lang.String	DEFAULT_NAME The name of the default relation set.
static java.lang.String	LOCAL_NAME The name of the local relation set.

Method Summary

java.util.Set	getRelatedTableAliases(ITableAlias initialTableAlias) Returns all table aliases, which are related to the given alias.
java.util.Set	getRelations() Returns all relations within this relation set.
boolean	isLocal() Checks whether the given relation set is the local relation set.

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getName, getProperty

Field Detail

DEFAULT_NAME

static final java.lang.String DEFAULT_NAME

The name of the default relation set.

See Also:

IApplicationDefinition.getDefaultRelationSet(), Constant Field Values

LOCAL_NAME

static final java.lang.String LOCAL_NAME

The name of the local relation set.

See Also:

IApplicationDefinition.getLocalRelationSet(), Constant Field Values

Method Detail

getRelations

java.util.Set getRelations()

Returns all relations within this relation set.

Returns:

Set of IRelation

getRelatedTableAliases

java.util.Set getRelatedTableAliases(ITableAlias initialTableAlias)

Returns all table aliases, which are related to the given alias.

Remark: The given initial table alias will be contained within the result set as well.

Parameters:

initialTableAlias - initial table alias to determine related table aliases of

Returns:

Set of ITableAlias

isLocal

boolean isLocal()

Checks whether the given relation set is the local relation set.

Returns:

true if this is the local relation set otherwise false