com.sap.sl.sdk.authoring.businesslayer

Interface NavigationPath

All Superinterfaces:

Identifiable, Nameable

public interface NavigationPath
extends Identifiable, Nameable

A representation of the model object 'Navigation Path'.

This object represents custom navigation paths used to drill business objects in reporting tools.

Use BusinessLayerFactory.createNavigationPath(String, BusinessLayer) to instantiate a navigation path.

The following features are supported:

• Description
• Dimensions

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the value of the 'Description' attribute.
java.util.List<Dimension>	getDimensions() Returns the value of the 'Dimensions' 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. The default value is "".

This is the description of the navigation path.

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 is the description of the navigation path. In the information design tool, the description can be set in the Business Layer editor.

Parameters:

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

See Also:

getDescription()

getDimensions

java.util.List<Dimension> getDimensions()

Returns the value of the 'Dimensions' reference list. The list contents are of type Dimension.

This is the list of the dimensions that compose the navigation path.

Returns:

the value of the 'Dimensions' reference list.