@ExperimentalApi @Immutable public interface LicenseRole
LicenseRole
s exist in one of 3 states: defined, installed, and active:
DEFINED -------- | |\ | | installation | | uninstallation (add license) | | (remove license) | | \| | ---------- INSTALLED ---------- | |\ | | activation | | inactivation (license is current) | | (license expires or is exceeded) | | \| | -------- ACTIVE
Note that an active LicenseRole
is necessarily also defined and installed, whereas a
a defined LicenseRole
may or may not be installed or active.
Modifier and Type | Method and Description |
---|---|
Set<String> |
getGroups()
Return the set of Group Ids associated with the role.
|
LicenseRoleId |
getId()
Returns the canonical
LicenseRoleId that uniquely identifies this LicenseRole . |
String |
getName()
Return the name of the license role.
|
com.atlassian.fugue.Option<String> |
getPrimaryGroup()
Return the primary group configured for the role.
|
LicenseRole |
withGroups(Iterable<String> groups,
com.atlassian.fugue.Option<String> primaryGroup)
Return a new LicenseRole with its groups and primaryGroup set to the passed arguments.
|
@Nonnull LicenseRoleId getId()
LicenseRoleId
that uniquely identifies this LicenseRole
.LicenseRoleId
that uniquely identifies this LicenseRole
.@Nonnull String getName()
@Nonnull Set<String> getGroups()
@Nonnull com.atlassian.fugue.Option<String> getPrimaryGroup()
Option.none()
may be returned
if no primary is configured.@Nonnull LicenseRole withGroups(@Nonnull Iterable<String> groups, @Nonnull com.atlassian.fugue.Option<String> primaryGroup)
groups
- the groups associated with the role.primaryGroup
- primary group for the role. A value of Option.none()
can be
passed indicate that there is no primaryGroup for the role.IllegalArgumentException
- if groups contains null or the primaryGroup is not within groups.Copyright © 2002-2015 Atlassian. All Rights Reserved.