com.atlassian.jira.application.ApplicationRole |
![]() |
Represents an Application Role in JIRA. An application role defines which users (indirectly through groups) can access an application.
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.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the default groups configured for the role.
| |||||||||||
Return the set of groups associated with the role including the default ones.
| |||||||||||
Returns the canonical ApplicationKey that uniquely identifies this
ApplicationRole . | |||||||||||
Return the name of the
ApplicationRole . | |||||||||||
Returns the total number of seats of this
ApplicationRole issued with the licence. | |||||||||||
Indicates if the Application/Product is defined.
| |||||||||||
Returns whether the role is part of the core platform.
| |||||||||||
Determines whether
ApplicationRole should be selected by default on user creation | |||||||||||
Return a new
ApplicationRole with its groups and default groups set to the passed
values. | |||||||||||
Returns a new
ApplicationRole with its selected by default settings set to passed value |
Return the default groups configured for the role.
Return the set of groups associated with the role including the default ones.
Returns the canonical ApplicationKey that uniquely identifies this ApplicationRole
.
ApplicationRole
.
Return the name of the ApplicationRole
. The name is i18ned for the calling user if possible.
ApplicationRole
role. The name is i18ned for the calling user if possible.
Returns the total number of seats of this ApplicationRole
issued with the licence.
ApplicationRole
issued with the licence.
Indicates if the Application/Product is defined. This is true when the 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 defined
Returns whether the role is part of the core platform.
Determines whether ApplicationRole
should be selected by default on user creation
true
when ApplicationRole
should be selected by default on user creation
Return a new 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. |
---|
Returns a new ApplicationRole
with its selected by default settings set to passed value
selectedByDefault | the new selected by default settings |
---|
ApplicationRole
with its selected by default settings set to passed value