com.k15t.scroll.scm.api

Interface SpaceRolesService

public interface SpaceRolesService

This service is responsible for retrieving the space roles of spaces managed by Scroll Versions and/or Scroll Translations.

Method Summary

Modifier and Type	Method and Description
SpaceRoles	getConfiguredSpaceRoles(String spaceKey) Get the configured space roles of a space.
SpaceRoles	getEffectiveSpaceRoles(String spaceKey) Get the effective space roles of a space.

Method Detail

getEffectiveSpaceRoles

SpaceRoles getEffectiveSpaceRoles(String spaceKey)

Get the effective space roles of a space.

The effective space roles are calculated as followed:

Authors: - when no authors are configured, every user with edit permissions in the space is an author. - when authors are configured in the space, those are the authors. - all Confluence administrators are automatically authors.

Reviewers: - when no reviewers and no authors are configured, every user with view permissions in the space is a reviewer. - when reviewers are configured in the space, those are the reviewers. - all Confluence administrators are automatically reviewers.

Translators: - when no translators and no authors are configured, every user with edit permissions in the space is a translator. - when translators are configured in the space, those are the translators. - all Confluence administrators are automatically authors.

Doc-Admins: - all space admins are automatically doc-admins. - all users configured as doc-admins are doc-admins. - all Confluence administrators are automatically doc-admins.

Parameters:

spaceKey - the space key of the space to retrieve the space roles from

Returns:

the effective space roles

getConfiguredSpaceRoles

SpaceRoles getConfiguredSpaceRoles(String spaceKey)

Get the configured space roles of a space. The configured space roles are the space roles configured under Space Tools > Scroll Add-ons > Administration > Permissions.

Parameters:

spaceKey - the space key of the space to retrieve the space roles from

Returns:

the configured space roles