com.atlassian.jira.application

Interface ApplicationRoleDefinitions

All Known Implementing Classes:

DefaultApplicationRoleDefinitions, MockApplicationRoleDefinitions

@ParametersAreNonnullByDefault
public interface ApplicationRoleDefinitions

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).

Since:

v7.0

See Also:

ApplicationRole

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ApplicationRoleDefinitions.ApplicationRoleDefinition Definition of an ApplicationRole.

Method Summary

Modifier and Type	Method and Description
Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition>	getDefined() Return all the defined ApplicationRoleDefinitions.
io.atlassian.fugue.Option<ApplicationRoleDefinitions.ApplicationRoleDefinition>	getDefined(com.atlassian.application.api.ApplicationKey key) Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey provided it is defined.
Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition>	getLicensed() Return all the licensed ApplicationRoleDefinitions.
io.atlassian.fugue.Option<ApplicationRoleDefinitions.ApplicationRoleDefinition>	getLicensed(com.atlassian.application.api.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).
boolean	isDefined(com.atlassian.application.api.ApplicationKey key) Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is defined.
boolean	isLicensed(com.atlassian.application.api.ApplicationKey key) Return true if the ApplicationRoleDefinitions.ApplicationRoleDefinition identified by the given ApplicationKey is licensed.

Method Detail

getDefined

@Nonnull
Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined()

Return all the defined ApplicationRoleDefinitions.

Returns:

all the defined ApplicationRoleDefinitions.

getDefined

@Nonnull
io.atlassian.fugue.Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getDefined(com.atlassian.application.api.ApplicationKey key)

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

Parameters:

key - the ID to check.

Returns:

Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey if it is defined or Option.none() otherwise.

isDefined

boolean isDefined(com.atlassian.application.api.ApplicationKey key)

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

Parameters:

key - the key to check.

Returns:

true when the passed ApplicationRoleDefinitions.ApplicationRoleDefinition is defined.

getLicensed

@Nonnull
Iterable<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed()

Return all the licensed ApplicationRoleDefinitions.

Returns:

all the licensed ApplicationRoleDefinitions.

getLicensed

io.atlassian.fugue.Option<ApplicationRoleDefinitions.ApplicationRoleDefinition> getLicensed(com.atlassian.application.api.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 Option.none() is returned if the passed ApplicationKey does not have a license.

Parameters:

key - the ID to check.

Returns:

Return the ApplicationRoleDefinitions.ApplicationRoleDefinition associated with the passed ApplicationKey if it has a license or Option.none() otherwise.

isLicensed

boolean isLicensed(com.atlassian.application.api.ApplicationKey key)

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

Parameters:

key - the key to check.

Returns:

true when the passed ApplicationRoleDefinitions.ApplicationRoleDefinition is licensed.