@ExperimentalApi
public interface LicenseRoleManager
LicenseRole
s. Unless otherwise stated,
the methods on this class only deal with installed LicenseRole
s. An installed
LicenseRole
has been defined by a plugin/product AND has an accompanying
license that grants that role.Modifier and Type | Method and Description |
---|---|
Set<String> |
getGroupsForInstalledLicenseRoles()
Get the
Set of group names that have been associated with one or more
installed license roles. |
com.atlassian.fugue.Option<LicenseRole> |
getLicenseRole(LicenseRoleId licenseRoleId)
Return the installed
LicenseRole associated with the passed ID or
Option.none() if no such role exists. |
Set<LicenseRole> |
getLicenseRoles()
Returns the
Set of all currently installed LicenseRole s. |
int |
getUserCount(LicenseRoleId roleId)
Retrieve the number of active users for a specific license role (product).
|
boolean |
isLicenseRoleInstalled(LicenseRoleId licenseRoleId)
Return
true when the passed LicenseRoleId is installed. |
void |
removeGroupFromLicenseRoles(String groupName)
Removes any/all associations of the given group from all license roles.
|
LicenseRole |
setLicenseRole(LicenseRole role)
Save the passed
LicenseRole information to the database. |
@Nonnull com.atlassian.fugue.Option<LicenseRole> getLicenseRole(@Nonnull LicenseRoleId licenseRoleId)
LicenseRole
associated with the passed ID or
Option.none()
if no such role exists.
An installed LicenseRole
has been defined by a plugin/product
AND has an accompanying license that grants that role.licenseRoleId
- the ID to search for.LicenseRole
associated with the passed ID.@Nonnull Set<LicenseRole> getLicenseRoles()
Set
of all currently installed LicenseRole
s.
An installed LicenseRole
has been defined by a plugin/product
AND has an accompanying license that grants that role.Set
of installed LicenseRole
s.@Nonnull Set<String> getGroupsForInstalledLicenseRoles()
Set
of group names that have been associated with one or more
installed license roles.
An installed LicenseRole
has been defined by a plugin/product
AND has an accompanying license that grants that role.LicenseRoleAdminService
void removeGroupFromLicenseRoles(@Nonnull String groupName)
groupName
- the name of the group to remove.boolean isLicenseRoleInstalled(@Nonnull LicenseRoleId licenseRoleId)
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.licenseRoleId
- the ID to check.true
when the passed LicenseRoleId
is installed.@Nonnull LicenseRole setLicenseRole(@Nonnull LicenseRole role)
LicenseRole
information to the database.
This method will only accept the passed role if:
role
- the role to save.IllegalArgumentException
- if passed role does not contain valid groups, if the primary group
is invalid or if the role is not installed.int getUserCount(@Nonnull LicenseRoleId roleId)
roleId
- is the license role ID used to identify the product.Copyright © 2002-2015 Atlassian. All Rights Reserved.