Skip navigation links
A C G I L M P R S T V W 

A

acceptContentWithoutValues() - Method in interface com.k15t.scroll.scm.api.Condition
This flag indicates if the condition is also fulfilled when no values are set for the attribute at all.
Attribute - Interface in com.k15t.scroll.scm.api
This class represents an attribute managed by Scroll Versions.
AttributeCreateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when an attribute is created in a space.
AttributeRemoveEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when an attribute is removed in a space.
AttributeUpdateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when an attribute is updated in a space.
AttributeValuesUpdateEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when the attribute values of a page have changed.

C

com.k15t.scroll.scm.api - package com.k15t.scroll.scm.api
 
com.k15t.scroll.scm.api.events.page - package com.k15t.scroll.scm.api.events.page
 
com.k15t.scroll.scm.api.events.space - package com.k15t.scroll.scm.api.events.space
 
Condition - Interface in com.k15t.scroll.scm.api
This class represents an attribute-specific condition of a variant.
ConvertToUnversionedEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a ScrollPage.Type.modificationPage is converted to a ScrollPage.Type.unversionedPage.
ConvertToVersionedEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a ScrollPage.Type.unversionedPage is converted to a ScrollPage.Type.modificationPage.
convertXliffToPageTranslations(InputStream) - Method in interface com.k15t.scroll.scm.api.TranslationService
Converts XLIFF into a page translation by converting the translation in XLIFF into Confluence Storage format and adding metadata like the translated title and Confluence page id to the page translation.
createXliffForPage(long, String, OutputStream) - Method in interface com.k15t.scroll.scm.api.TranslationService
Converts the content of the default language of a given page to XLIFF.

G

getAttribute() - Method in interface com.k15t.scroll.scm.api.Condition
 
getAttribute() - Method in interface com.k15t.scroll.scm.api.events.space.AttributeCreateEvent
 
getAttribute() - Method in interface com.k15t.scroll.scm.api.events.space.AttributeRemoveEvent
 
getAuthorGroupNames() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getAuthorUserKeys() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getConditions() - Method in interface com.k15t.scroll.scm.api.Variant
 
getConfiguredSpaceRoles(String) - Method in interface com.k15t.scroll.scm.api.SpaceRolesService
Get the configured space roles of a space.
getConfluencePageId() - Method in interface com.k15t.scroll.scm.api.PageTranslation
Get the Confluence page id of the page this translation belongs to.
getConfluencePageId() - Method in interface com.k15t.scroll.scm.api.ScrollPage
Get the page id of the Confluence page representing the Scroll Page in this version.
getConfluencePageRevision() - Method in interface com.k15t.scroll.scm.api.PageTranslation
 
getContent() - Method in interface com.k15t.scroll.scm.api.PageTranslation
Get the translated content.
getDescription() - Method in interface com.k15t.scroll.scm.api.Attribute
 
getDescription() - Method in interface com.k15t.scroll.scm.api.Variant
 
getDescription() - Method in interface com.k15t.scroll.scm.api.Version
 
getDocAdminGroupNames() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getDocAdminUserKeys() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getEditedLanguage() - Method in interface com.k15t.scroll.scm.api.events.page.ScrollPageEditEvent
Get the language the Scroll Page was edited in.
getEffectiveSpaceRoles(String) - Method in interface com.k15t.scroll.scm.api.SpaceRolesService
Get the effective space roles of a space.
getFromVersion() - Method in interface com.k15t.scroll.scm.api.events.page.RescheduleEvent
 
getId() - Method in interface com.k15t.scroll.scm.api.Attribute
 
getId() - Method in interface com.k15t.scroll.scm.api.Variant
 
getId() - Method in interface com.k15t.scroll.scm.api.Version
 
getKey() - Method in interface com.k15t.scroll.scm.api.Language
 
getLanguage() - Method in interface com.k15t.scroll.scm.api.events.page.TranslationStatusChangeEvent
 
getLanguage() - Method in interface com.k15t.scroll.scm.api.events.space.LanguageCreateEvent
 
getLanguage() - Method in interface com.k15t.scroll.scm.api.events.space.LanguageRemoveEvent
 
getLanguageKey() - Method in interface com.k15t.scroll.scm.api.PageTranslation
Get the language key of the translation.
getLocale() - Method in interface com.k15t.scroll.scm.api.Language
 
getName() - Method in interface com.k15t.scroll.scm.api.Attribute
 
getName() - Method in interface com.k15t.scroll.scm.api.Variant
 
getName() - Method in interface com.k15t.scroll.scm.api.Version
 
getNewAttribute() - Method in interface com.k15t.scroll.scm.api.events.space.AttributeUpdateEvent
 
getNewAttributeValues() - Method in interface com.k15t.scroll.scm.api.events.page.AttributeValuesUpdateEvent
Get the new attribute values assigned to the page.
getNewConfiguredSpaceRoles() - Method in interface com.k15t.scroll.scm.api.events.space.SpaceRolesConfigChangeEvent
Get the updated space roles.
getNewStatus() - Method in interface com.k15t.scroll.scm.api.events.page.TranslationStatusChangeEvent
 
getNewStatus() - Method in interface com.k15t.scroll.scm.api.events.page.WorkflowStatusChangeEvent
 
getNewVariant() - Method in interface com.k15t.scroll.scm.api.events.space.VariantUpdateEvent
 
getNewVersion() - Method in interface com.k15t.scroll.scm.api.events.page.ConvertToVersionedEvent
 
getNewVersion() - Method in interface com.k15t.scroll.scm.api.events.page.ModificationAddEvent
 
getNewVersion() - Method in interface com.k15t.scroll.scm.api.events.space.VersionUpdateEvent
 
getOldAttribute() - Method in interface com.k15t.scroll.scm.api.events.space.AttributeUpdateEvent
 
getOldAttributeValues() - Method in interface com.k15t.scroll.scm.api.events.page.AttributeValuesUpdateEvent
Get the attribute values assigned to the page before the update was performed.
getOldConfiguredSpaceRoles() - Method in interface com.k15t.scroll.scm.api.events.space.SpaceRolesConfigChangeEvent
Get the old space roles.
getOldStatus() - Method in interface com.k15t.scroll.scm.api.events.page.TranslationStatusChangeEvent
 
getOldStatus() - Method in interface com.k15t.scroll.scm.api.events.page.WorkflowStatusChangeEvent
 
getOldVariant() - Method in interface com.k15t.scroll.scm.api.events.space.VariantUpdateEvent
 
getOldVersion() - Method in interface com.k15t.scroll.scm.api.events.page.ConvertToUnversionedEvent
 
getOldVersion() - Method in interface com.k15t.scroll.scm.api.events.space.VersionUpdateEvent
 
getPrecedingVersionId() - Method in interface com.k15t.scroll.scm.api.Version
 
getPublishedLanguages() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the published languages.
getPublishedLanguages() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the published languages.
getPublishedVariants() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the published variants.
getPublishedVariants() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the published variants.
getPublishedVersion() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the published version.
getPublishedVersion() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the published version.
getPublishType() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the publish type.
getPublishType() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the publish type.
getReleaseDate() - Method in interface com.k15t.scroll.scm.api.Version
 
getRequiredAttributeValues() - Method in interface com.k15t.scroll.scm.api.Condition
 
getReviewerGroupNames() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getReviewerUserKeys() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getScrollPage() - Method in interface com.k15t.scroll.scm.api.events.page.PageEvent
 
getScrollPageId() - Method in interface com.k15t.scroll.scm.api.PageTranslation
 
getScrollPageId() - Method in interface com.k15t.scroll.scm.api.ScrollPage
Get the Scroll Page Id.
getScrollPageKey() - Method in interface com.k15t.scroll.scm.api.ScrollPage
 
getScrollPageKeyUrlPath() - Method in interface com.k15t.scroll.scm.api.ScrollPage
 
getScrollPageTitle() - Method in interface com.k15t.scroll.scm.api.ScrollPage
Get the Scroll Page Title of the Scroll Page.
getSourceSpaceKey() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the source space key.
getSourceSpaceKey() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the source space key.
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.Attribute
 
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.events.space.SpaceEvent
 
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.Language
 
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.ScrollPage
 
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.Variant
 
getSpaceKey() - Method in interface com.k15t.scroll.scm.api.Version
 
getTargetApplicationLinkId() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
When publishing to another system with the Scroll Remote Publishing Endpoint, this method gets the ID of the application link to the other system.
getTargetApplicationLinkId() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
When publishing to another system with the Scroll Remote Publishing Endpoint, this method gets the ID of the application link to the other system.
getTargetSpaceKey() - Method in interface com.k15t.scroll.scm.api.events.space.PostPublishEvent
Get the target space key.
getTargetSpaceKey() - Method in interface com.k15t.scroll.scm.api.events.space.PrePublishEvent
Get the target space key.
getTitle() - Method in interface com.k15t.scroll.scm.api.PageTranslation
Get the translated title.
getToVersion() - Method in interface com.k15t.scroll.scm.api.events.page.RescheduleEvent
 
getTranslatorGroupNames() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getTranslatorUserKeys() - Method in interface com.k15t.scroll.scm.api.SpaceRoles
 
getType() - Method in interface com.k15t.scroll.scm.api.ScrollPage
 
getValues() - Method in interface com.k15t.scroll.scm.api.Attribute
 
getVariant() - Method in interface com.k15t.scroll.scm.api.events.space.VariantCreateEvent
 
getVariant() - Method in interface com.k15t.scroll.scm.api.events.space.VariantRemoveEvent
 
getVersion() - Method in interface com.k15t.scroll.scm.api.events.page.ModificationDeleteEvent
 
getVersion() - Method in interface com.k15t.scroll.scm.api.events.page.RemoveFromVersionEvent
 
getVersion() - Method in interface com.k15t.scroll.scm.api.events.space.VersionCreateEvent
 
getVersion() - Method in interface com.k15t.scroll.scm.api.events.space.VersionRemoveEvent
 
getVersion() - Method in interface com.k15t.scroll.scm.api.ScrollPage
 
getVersionId() - Method in interface com.k15t.scroll.scm.api.PageTranslation
Get the id of the (Scroll) version of this page.

I

importPageTranslation(PageTranslation, TranslationStatus, boolean) - Method in interface com.k15t.scroll.scm.api.TranslationService
Import a page translation.
isDefault() - Method in interface com.k15t.scroll.scm.api.Language
 
isHidden() - Method in interface com.k15t.scroll.scm.api.Version
Determines if a version is hidden.

L

Language - Interface in com.k15t.scroll.scm.api
This class represents a language in Scroll Translations.
LanguageCreateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a language is created in a space.
LanguageRemoveEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a language is removed in a space.

M

ModificationAddEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a page has been added to a version.
ModificationDeleteEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a page has been marked as removed in a version.

P

PageEvent - Interface in com.k15t.scroll.scm.api.events.page
This interface indicates that an event is published in the context of a page.
PageTranslation - Interface in com.k15t.scroll.scm.api
This class represents the translation of a page in a specific language and is created from an imported XLIFF file.
PostPublishEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published at the end of a publishing process after all pages have been published.
PrePublishEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published at the beginning of a publishing process.
PublishType - Enum in com.k15t.scroll.scm.api
This enum represents the different types of publishing that are possible with Scroll Versions.

R

RemoveFromVersionEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a versioned Confluence page is removed (either a ScrollPage.Type.modificationPage or a ScrollPage.Type.removePage).
RescheduleEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when a ScrollPage.Type.modificationPage has been rescheduled to a different version.

S

ScrollPage - Interface in com.k15t.scroll.scm.api
A ScrollPage represents a page in a space with either versions, variants or languages.
ScrollPage.Type - Enum in com.k15t.scroll.scm.api
 
ScrollPageEditEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published whenever a Scroll Page is edited through the Confluence Editor.
SpaceEvent - Interface in com.k15t.scroll.scm.api.events.space
This interface indicates that an event is published in the context of a space.
SpaceRoles - Interface in com.k15t.scroll.scm.api
This class represents the space roles of Scroll Versions and Scroll Translations.
SpaceRolesConfigChangeEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when the space roles in a space are changed.
SpaceRolesService - Interface in com.k15t.scroll.scm.api
This service is responsible for retrieving the space roles of spaces managed by Scroll Versions and/or Scroll Translations.

T

TranslationService - Interface in com.k15t.scroll.scm.api
This service is responsible for handling translations of pages in spaces with multiple languages.
TranslationStatus - Enum in com.k15t.scroll.scm.api
This enum represents the different translation status a page can have in a single language with Scroll Translations.
TranslationStatusChangeEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when the translation status of a page is updated.

V

valueOf(String) - Static method in enum com.k15t.scroll.scm.api.PublishType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.k15t.scroll.scm.api.ScrollPage.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.k15t.scroll.scm.api.TranslationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.k15t.scroll.scm.api.WorkflowStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.k15t.scroll.scm.api.PublishType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.k15t.scroll.scm.api.ScrollPage.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.k15t.scroll.scm.api.TranslationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.k15t.scroll.scm.api.WorkflowStatus
Returns an array containing the constants of this enum type, in the order they are declared.
Variant - Interface in com.k15t.scroll.scm.api
This class represents a variant managed by Scroll Versions.
VariantCreateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a variant is created in a space.
VariantRemoveEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a variant is removed in a space.
VariantUpdateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a variant is updated in a space.
Version - Interface in com.k15t.scroll.scm.api
This class represents a version managed by Scroll Versions in a single space.
VersionCreateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a version is created in a space.
VersionRemoveEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a version is removed in a space.
VersionUpdateEvent - Interface in com.k15t.scroll.scm.api.events.space
This event is published when a version is updated in a space.

W

WorkflowStatus - Enum in com.k15t.scroll.scm.api
This enum represents the different workflow status a page can have when using the Scroll Versions built-in workflow.
WorkflowStatusChangeEvent - Interface in com.k15t.scroll.scm.api.events.page
This event is published when the workflow status of a page is updated.
A C G I L M P R S T V W 
Skip navigation links

Copyright © 2019 K15t GmbH. All rights reserved.