com.atlassian.jira.license
Interface LicenseRoleDefinitions

All Known Implementing Classes:

MockLicenseRoleDefinitions, PluginLicenseRoleDefinitions

public interface LicenseRoleDefinitions

Methods for accessing and querying LicenseRoleDefinition objects.

Since:

v7.0

Method Summary

com.atlassian.fugue.Option<LicenseRoleDefinition>	getAuthenticatedRoleDefinition(LicenseRoleId licenseRoleId) Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is authenticated.
Set<LicenseRoleDefinition>	getAuthenticatedRoleDefinitions() Return all the authenticated LicenseRoleDefinitions.
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.
boolean	isLicenseRoleAuthenticated(LicenseRoleId licenseRoleId) Return true when the passed LicenseRoleId is authenticated.
boolean	isLicenseRoleDefined(LicenseRoleId licenseRoleId) Return true when the passed LicenseRoleId is defined.

Method Detail

getDefinedRoleDefinitions

@Nonnull
Set<LicenseRoleDefinition> getDefinedRoleDefinitions()

Return all the defined LicenseRoleDefinitions. A LicenseRoleDefinition is defined when a plugin provides it. This does not indicate if the LicenseRoleDefinition is licensed or not.

Returns:

all the defined LicenseRoleDefinitions.

getAuthenticatedRoleDefinitions

@Nonnull
Set<LicenseRoleDefinition> getAuthenticatedRoleDefinitions()

Return all the authenticated LicenseRoleDefinitions. A LicenseRoleDefinition is authenticated when a plugin defines it and it is licensed.

Returns:

all the authenticated LicenseRoleDefinitions.

isLicenseRoleDefined

boolean isLicenseRoleDefined(@Nonnull
                             LicenseRoleId licenseRoleId)

Return true when the passed LicenseRoleId is defined. A LicenseRoleId is defined when a plugin provides a LicenseRoleDefinition. This does not indicate if the LicenseRoleId is licensed or not.

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is defined.

isLicenseRoleAuthenticated

boolean isLicenseRoleAuthenticated(@Nonnull
                                   LicenseRoleId licenseRoleId)

Return true when the passed LicenseRoleId is authenticated. A LicenseRoleId is authenticated when a plugin provides a LicenseRoleDefinition and it is also licensed.

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is authenticated.

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 LicenseRoleId is defined when a plugin provides a LicenseRoleDefinition. This does not indicate if the LicenseRoleId is licensed or not.

Parameters:

licenseRoleId - the ID to check.

Returns:

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

getAuthenticatedRoleDefinition

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

Return the LicenseRoleDefinition associated with the passed LicenseRoleId provided it is authenticated. A value of Option.none() is returned if the passed LicenseRoleId is not authenticated. A LicenseRoleId is authenticated when a plugin provides a LicenseRoleDefinition and it is licensed.

Parameters:

licenseRoleId - the ID to check.

Returns:

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