com.k15t.scroll.scm.api

Interface ScrollPage

public interface ScrollPage

A ScrollPage represents a page in a space with either versions, variants or languages. It is an abstraction that hides away the implementation details how versioned, conditional and translated content is maintained by the system and always represents the content in one version.

• In versioned spaces a ScrollPage may represent one of up to one Confluence page per version. If no Confluence page exists for a specific version, the content of the preceding version's page is inherited.
• In translated spaces all translations are maintained on a single Confluence page.
• All Confluence pages belonging to the same ScrollPage share the same Scroll Page ID.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScrollPage.Type

Method Summary

Modifier and Type	Method and Description
long	getConfluencePageId() Get the page id of the Confluence page representing the Scroll Page in this version.
String	getScrollPageId() Get the Scroll Page Id.
String	getScrollPageKey()
String	getScrollPageKeyUrlPath()
String	getScrollPageTitle() Get the Scroll Page Title of the Scroll Page.
String	getSpaceKey()
ScrollPage.Type	getType()
Version	getVersion()

Method Detail

getConfluencePageId

long getConfluencePageId()

Get the page id of the Confluence page representing the Scroll Page in this version. See ScrollPage.Type

Returns:

the page id of the Confluence page representing the Scroll Page.

getScrollPageId

String getScrollPageId()

Get the Scroll Page Id. The Scroll Page Id identifies all Confluence pages of a single Scroll Page. This means that the master page and all it's modification pages and remove pages share the same Scroll Page Id.

Returns:

the Scroll Page Id of the Scroll Page.

getScrollPageTitle

String getScrollPageTitle()

Get the Scroll Page Title of the Scroll Page. The Scroll Page Title is the title displayed in the UI, not the Confluence page title. When there are multiple languages in a space this method will always return the title in the default language.

Returns:

the Scroll Page Title of the Scroll Page.

getScrollPageKey

String getScrollPageKey()

getScrollPageKeyUrlPath

String getScrollPageKeyUrlPath()

getSpaceKey

String getSpaceKey()

getVersion

Version getVersion()

getType

ScrollPage.Type getType()