com.ibm.mashups.enabler.space
Interface SpaceNode

All Superinterfaces:

com.ibm.mashups.enabler.DefaultLocalized, Identifiable, Localized, MetaData, ModifiableLocalized, ModifiableMetaData, ThemeProvider

public SpaceNode
extends Identifiable, ModifiableLocalized, com.ibm.mashups.enabler.DefaultLocalized, ModifiableMetaData, ThemeProvider

Interface representing a space node.

Method Summary

Identifiable	getRootNavigation() Returns the root navigation ID, or null if no navigation has been associated with the node.
String	getExportSpaceURL() Returns a URL to export the space in zip file format
String	getExportTemplateURL() Returns a URL to export the space as a template in zip file format
void	saveAsTemplate() Save the space as template.
Boolean	isHidden() Returns whether this space node is flagged as hidden.
void	setHidden(Boolean hide) Allows to flag the space node as hidden or visible.
Boolean	confirmSetHidden(Boolean hide) Confirms whether setting the hidden flag is possible.
Boolean	isFavorite() Returns whether this space node is flagged as a favorite space.
void	setFavorite(Boolean favorite) Allows to mark the space node as favorite ir non-favorite.

Methods inherited from interface com.ibm.mashups.enabler.Identifiable

getID

Methods inherited from interface com.ibm.mashups.enabler.ModifiableLocalized

setTitle, confirmSetTitle, removeTitle, confirmRemoveTitle, removeTitles, confirmRemoveTitles, setDescription, confirmSetDescription, removeDescription, confirmRemoveDescription, removeDescriptions, confirmRemoveDescriptions

Methods inherited from interface com.ibm.mashups.enabler.Localized

getLocales, getTitle, getTitles, getDescription, getDescriptions

Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData

setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData

Methods inherited from interface com.ibm.mashups.enabler.MetaData

getMetaDataNames, getMetaData

Methods inherited from interface com.ibm.mashups.enabler.ThemeProvider

getTheme, setTheme, getThemeIdentifier, setThemeIdentifier

Method Detail

getRootNavigation

Identifiable getRootNavigation()

Returns the root navigation ID, or null if no navigation has been associated with the node.

Returns:

the root navigation ID, or null if it has not been associated

getExportSpaceURL

String getExportSpaceURL()

Returns a URL to export the space in zip file format

Returns:

link to export the space

getExportTemplateURL

String getExportTemplateURL()

Returns a URL to export the space as a template in zip file format

Returns:

link to export the space as a template

saveAsTemplate

void saveAsTemplate()

Save the space as template.

isHidden

Boolean isHidden()

Returns whether this space node is flagged as hidden. It is the responsibility of the UI to render the space nodes correctly and honor this flag.

Returns:

true if the space is flagged as hidden, otherwise false

setHidden

void setHidden(Boolean hide)

Allows to flag the space node as hidden or visible.

Parameters:

hide - true to hide the space, otherwise false

confirmSetHidden

Boolean confirmSetHidden(Boolean hide)

Confirms whether setting the hidden flag is possible.

Parameters:

hide - true to hide the space, otherwise false

Returns:

true if the value can be set, otherwise false.

isFavorite

Boolean isFavorite()

Returns whether this space node is flagged as a favorite space.

Returns:

true if the space is flagged as favorite, otherwise false

setFavorite

void setFavorite(Boolean favorite)

Allows to mark the space node as favorite ir non-favorite.

Parameters:

favorite - true to mark this space as favorite, otherwise false