@ParametersAreNonnullByDefault public interface

ApplicationRoleDefinitions

com.atlassian.jira.application.ApplicationRoleDefinitions
Known Indirect Subclasses

Class Overview

Manager for accessing the ApplicationRoleDefinitions.ApplicationRoleDefinitions in JIRA.

An ApplicationRoleDefinition can be in these states:

Defined
The ApplicationRoleDefinition defined by a plugin or by JIRA directly. A defined plugin may or may not have a license associated.
Licensed
The ApplicationRoleDefinition has an associated license in JIRA (irrespective of the license state whether it has expired or it user limit has been exceeded).

See Also

Summary

Nested Classes
interface ApplicationRoleDefinitions.ApplicationRoleDefinition Definition of an ApplicationRole. 
Public Methods
@Nonnull Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined()
Return all the defined ApplicationRoleDefinitions.
@Nonnull Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined(ApplicationKey key)
Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey provided it is defined.
Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed(ApplicationKey key)
Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey provided it has a license (irrespective of the license state whether it has expired or it user limit has been exceeded).
@Nonnull Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed()
Return all the licensed ApplicationRoleDefinitions.
boolean isDefined(ApplicationKey key)
Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is defined.
boolean isLicensed(ApplicationKey key)
Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is licensed.

Public Methods

@Nonnull public Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined ()

Return all the defined ApplicationRoleDefinitions.

Returns
  • all the defined ApplicationRoleDefinitions.

@Nonnull public Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined (ApplicationKey key)

Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey provided it is defined. A value of none() is returned if the passed ApplicationKey is undefined.

Parameters
key the ID to check.
Returns

public Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed (ApplicationKey key)

Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey provided it has a license (irrespective of the license state whether it has expired or it user limit has been exceeded). A value of none() is returned if the passed ApplicationKey does not have a license.

Parameters
key the ID to check.
Returns

@Nonnull public Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed ()

Return all the licensed ApplicationRoleDefinitions.

Returns
  • all the licensed ApplicationRoleDefinitions.

public boolean isDefined (ApplicationKey key)

Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is defined.

Parameters
key the key to check.
Returns

public boolean isLicensed (ApplicationKey key)

Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is licensed.

Parameters
key the key to check.
Returns