com.sap.sl.sdk.authoring.datafoundation

Interface Context

All Superinterfaces:

Identifiable, Nameable

public interface Context
extends Identifiable, Nameable

A representation of the model object 'Context'.

A context is a collection of joins which provide a valid query path. See the Information Design Tool User Guide for more information.

Use DataFoundationFactory.createContext(String, DataFoundation) to instantiate a context for a data foundation.

The following features are supported:

• Description
• Data Foundation
• Excluded Joins
• Included Joins

Method Summary

Modifier and Type	Method and Description
DataFoundation	getDataFoundation() Returns the value of the 'Data Foundation' container reference.
java.lang.String	getDescription() Returns the value of the 'Description' attribute.
java.util.List<Join>	getExcludedJoins() Returns the value of the 'Excluded Joins' reference list.
java.util.List<Join>	getIncludedJoins() Returns the value of the 'Included Joins' reference list.
void	setDescription(java.lang.String value) Sets the value of the 'Description' attribute.

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Identifiable

getIdentifier

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Nameable

getName, setName

Method Detail

getDescription

java.lang.String getDescription()

Returns the value of the 'Description' attribute.

This string represents the description of the context.

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String)

setDescription

void setDescription(java.lang.String value)

Sets the value of the 'Description' attribute.

This string represents the description of the context.

Parameters:

value - the new value of the 'Description' attribute.

See Also:

getDescription()

getDataFoundation

DataFoundation getDataFoundation()

Returns the value of the 'Data Foundation' container reference. It is bidirectional and its opposite is 'Contexts'.

This is the data foundation to which the current context is attached.

Returns:

the value of the 'Data Foundation' container reference.

See Also:

DataFoundation.getContexts()

getExcludedJoins

java.util.List<Join> getExcludedJoins()

Returns the value of the 'Excluded Joins' reference list. The list contents are of type Join.

This is the list of joins of "excluded" state in the context.

You can use the add method to append a join to the end of the 'Excluded Joins' list. For example: getExcludedJoins().add(Join), if Join is not null.

Returns:

the value of the 'Excluded Joins' reference list.

getIncludedJoins

java.util.List<Join> getIncludedJoins()

Returns the value of the 'Included Joins' reference list. The list contents are of type Join.

This is the list of joins of "included" state in the context.

You can use the add method to append a join to the end of the 'Included Joins' list. For example: getIncludedJoins().add(Join), if Join is not null.

Returns:

the value of the 'Included Joins' reference list.