com.atlassian.jira.license

Class PluginLicenseRoleDefinitions

java.lang.Object

com.atlassian.jira.license.PluginLicenseRoleDefinitions

All Implemented Interfaces:

LicenseRoleDefinitions

public class PluginLicenseRoleDefinitions
extends Object
implements LicenseRoleDefinitions

Constructor Summary

Constructors

Constructor and Description
PluginLicenseRoleDefinitions(com.atlassian.plugin.PluginAccessor pluginAccessor, JiraLicenseManager licenseManager, com.atlassian.event.api.EventPublisher publisher)

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.
void	pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)
void	pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginLicenseRoleDefinitions

public PluginLicenseRoleDefinitions(com.atlassian.plugin.PluginAccessor pluginAccessor,
                            JiraLicenseManager licenseManager,
                            com.atlassian.event.api.EventPublisher publisher)

Method Detail

getDefinedRoleDefinitions

@Nonnull
public Set<LicenseRoleDefinition> getDefinedRoleDefinitions()

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

getDefinedRoleDefinitions in interface LicenseRoleDefinitions

Returns:

all the defined LicenseRoleDefinitions.

getInstalledRoleDefinitions

@Nonnull
public Set<LicenseRoleDefinition> getInstalledRoleDefinitions()

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

getInstalledRoleDefinitions in interface LicenseRoleDefinitions

Returns:

all the installed LicenseRoleDefinitions.

isLicenseRoleDefined

public boolean isLicenseRoleDefined(@Nonnull
                           LicenseRoleId licenseRoleId)

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

isLicenseRoleDefined in interface LicenseRoleDefinitions

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is defined.

isLicenseRoleInstalled

public boolean isLicenseRoleInstalled(@Nonnull
                             LicenseRoleId licenseRoleId)

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

isLicenseRoleInstalled in interface LicenseRoleDefinitions

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is installed.

getDefinedRoleDefinition

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

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

getDefinedRoleDefinition in interface LicenseRoleDefinitions

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
public com.atlassian.fugue.Option<LicenseRoleDefinition> getInstalledRoleDefinition(@Nonnull
                                                                                   LicenseRoleId licenseRoleId)

Description copied from interface: LicenseRoleDefinitions

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.

Specified by:

getInstalledRoleDefinition in interface LicenseRoleDefinitions

Parameters:

licenseRoleId - the ID to check.

Returns:

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

pluginModuleDisabled

@EventListener
public void pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)

pluginModuleEnabled

@EventListener
public void pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)