com.atlassian.jira.license

Interface LicenseRoleDefinitions

All Known Implementing Classes:

MockLicenseRoleDefinitions, PluginLicenseRoleDefinitions

public interface LicenseRoleDefinitions

Methods for accessing and querying the LicenseRoleDefinitions that provide the definition for LicenseRoles.

Since:

v6.4

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.fugue.Option<LicenseRoleDefinition>	getDefinedRoleDefinition(LicenseRoleId licenseRoleId) Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is defined.
Set<LicenseRoleDefinition>	getDefinedRoleDefinitions() Return all the defined LicenseRoleDefinitions.
com.atlassian.fugue.Option<LicenseRoleDefinition>	getInstalledRoleDefinition(LicenseRoleId licenseRoleId) Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is installed.
Set<LicenseRoleDefinition>	getInstalledRoleDefinitions() Return all the installed LicenseRoleDefinitions.
boolean	isLicenseRoleDefined(LicenseRoleId licenseRoleId) Return true if the LicenseRole identified by the given LicenseRoleId is defined.
boolean	isLicenseRoleInstalled(LicenseRoleId licenseRoleId) Return true when the passed LicenseRoleId is installed.

Method Detail

getDefinedRoleDefinitions

@Nonnull
Set<LicenseRoleDefinition> getDefinedRoleDefinitions()

Return all the defined LicenseRoleDefinitions. A LicenseRoleDefinition is considered defined when a plugin provides it. A defined LicenseRoleDefinition does not necessarily have an accompanying license.

Returns:

all the defined LicenseRoleDefinitions.

getInstalledRoleDefinitions

@Nonnull
Set<LicenseRoleDefinition> getInstalledRoleDefinitions()

Return all the installed LicenseRoleDefinitions. A LicenseRoleDefinition is considered installed when a plugin defines it and it has an accompanying license. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Returns:

all the installed LicenseRoleDefinitions.

isLicenseRoleDefined

boolean isLicenseRoleDefined(@Nonnull
                           LicenseRoleId licenseRoleId)

Return true if the LicenseRole identified by the given LicenseRoleId is defined. A defined LicenseRole has been defined by a plugin/product but does not necessarily have an accompanying license that grants that role.

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is defined.

isLicenseRoleInstalled

boolean isLicenseRoleInstalled(@Nonnull
                             LicenseRoleId licenseRoleId)

Return true when the passed LicenseRoleId is installed. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is installed.

getDefinedRoleDefinition

@Nonnull
com.atlassian.fugue.Option<LicenseRoleDefinition> getDefinedRoleDefinition(@Nonnull
                                                                                 LicenseRoleId licenseRoleId)

Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is defined. A value of Option.none() is returned if the passed LicenseRoleId is undefined. A defined LicenseRole has been defined by a plugin/product but does not necessarily have an accompanying license that grants that role.

Parameters:

licenseRoleId - the ID to check.

Returns:

Return the LicenseRoleDefinition associated with the passed LicenseRoleId if it is defined or Option.none() otherwise.

getInstalledRoleDefinition

@Nonnull
com.atlassian.fugue.Option<LicenseRoleDefinition> getInstalledRoleDefinition(@Nonnull
                                                                                   LicenseRoleId licenseRoleId)

Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is installed. A value of Option.none() is returned if the passed LicenseRoleId is not installed. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Parameters:

licenseRoleId - the ID to check.

Returns:

Return the LicenseRoleDefinition associated with the passed LicenseRoleId if it is installed or Option.none() otherwise.