@Immutable public interface ApplicationRole
An ApplicationRole
is defined by a JIRA plugin through it's module configuration.
An ApplicationRole
is regarded as licensed when there is a (potentially exceeded) license present in
JIRA that provides user seats for the ApplicationRole
that is uniquely identified by an ApplicationKey
.
Modifier and Type | Method and Description |
---|---|
Set<com.atlassian.crowd.embedded.api.Group> |
getDefaultGroups()
Return the default groups configured for the role.
|
Set<com.atlassian.crowd.embedded.api.Group> |
getGroups()
Return the set of groups associated with the role including the default ones.
|
com.atlassian.application.api.ApplicationKey |
getKey()
Returns the canonical
ApplicationKey that uniquely identifies this ApplicationRole . |
String |
getName()
Return the name of the
ApplicationRole . |
int |
getNumberOfSeats()
Returns the total number of seats of this
ApplicationRole issued with the licence. |
boolean |
isDefined()
Indicates if the Application/Product is defined.
|
boolean |
isPlatform()
Returns whether the role is part of the core platform.
|
boolean |
isSelectedByDefault()
Determines whether
ApplicationRole should be selected by default on user creation |
ApplicationRole |
withGroups(Iterable<com.atlassian.crowd.embedded.api.Group> groups,
Iterable<com.atlassian.crowd.embedded.api.Group> defaultGroups)
Return a new
ApplicationRole with its groups and default groups set to the passed
values. |
ApplicationRole |
withSelectedByDefault(boolean selectedByDefault)
Returns a new
ApplicationRole with its selected by default settings set to passed value |
@Nonnull com.atlassian.application.api.ApplicationKey getKey()
ApplicationKey
that uniquely identifies this ApplicationRole
.ApplicationKey
that uniquely identifies this ApplicationRole
.@Nonnull String getName()
ApplicationRole
. The name is i18ned for the calling user if possible.ApplicationRole
role. The name is i18ned for the calling user if possible.@Nonnull Set<com.atlassian.crowd.embedded.api.Group> getGroups()
@Nonnull Set<com.atlassian.crowd.embedded.api.Group> getDefaultGroups()
@Nonnull ApplicationRole withGroups(@Nonnull Iterable<com.atlassian.crowd.embedded.api.Group> groups, @Nonnull Iterable<com.atlassian.crowd.embedded.api.Group> defaultGroups)
ApplicationRole
with its groups and default groups set to the passed
values.groups
- the groups associated with the role.defaultGroups
- default groups for the role.ApplicationRole
with its groups and default groups set to the passed arguments.IllegalArgumentException
- if groups or defaultGroups contains null or if defaultGroups is not a
subset of groups.int getNumberOfSeats()
ApplicationRole
issued with the licence.ApplicationRole
issued with the licence.
boolean isSelectedByDefault()
ApplicationRole
should be selected by default on user creationtrue
when ApplicationRole
should be selected by default on user creationApplicationRole withSelectedByDefault(boolean selectedByDefault)
ApplicationRole
with its selected by default settings set to passed valueselectedByDefault
- the new selected by default settingsApplicationRole
with its selected by default settings set to passed valueboolean isDefined()
ApplicationRoleDefinition
identified by the ApplicationKey
is defined. An ApplicationRole
is defined when the JIRA plugin
that defines it is installed.true
if the ApplicationRole
is definedboolean isPlatform()
Copyright © 2002-2019 Atlassian. All Rights Reserved.