com.atlassian.jira.license

Interface LicenseRoleDetails

All Known Implementing Classes:

DefaultLicenseRoleDetails, MockLicenseRoleDetails

@ExperimentalApi
public interface LicenseRoleDetails

Encapsulates license role information for a given license.

Typical usage:

     JiraLicenseManager jlm = ...;
     LicenseDetails licenseDetails = jlm.getLicense();
     LicenseRoleDetails roleDetails = licenseDetails.getLicenseRoleDetails();

     Set licenseRoles = roleDetails.getIds();
     for (LicenseRoleId role : licenseRoles)
     {
         int numSeats = roleDetails.getUserLimit( role );
         ...
     }
 

Since:

v6.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNLIMITED_USERS The integer constant indicating an effectively unlimited number of users/seats.

Method Summary

Methods

Modifier and Type	Method and Description
Set<LicenseRoleId>	getIds() Returns the license roles encoded in the present license.
Set<LicenseRoleId>	getLicenseRoles() Deprecated. use getIds instead
int	getUserLimit(LicenseRoleId role) Returns the number of seats for the given LicenseRoleId.

Field Detail

UNLIMITED_USERS

static final int UNLIMITED_USERS

The integer constant indicating an effectively unlimited number of users/seats.

See Also:

Constant Field Values

Method Detail

getLicenseRoles

@Deprecated
@Nonnull
Set<LicenseRoleId> getLicenseRoles()

Deprecated. use getIds instead

Returns the license roles encoded in the present license. This may return an empty set, but never returns null.

getIds

@Nonnull
Set<LicenseRoleId> getIds()

Returns the license roles encoded in the present license. This may return an empty set, but never returns null.

Since:

6.4

getUserLimit

int getUserLimit(LicenseRoleId role)

Returns the number of seats for the given LicenseRoleId.

Returns:

the number of users/seats for the given license role; see also UNLIMITED_USERS.