com.atlassian.jira.sharing

Interface SharePermission

All Known Implementing Classes:

SharePermissionImpl

public interface SharePermission

Represents a JIRA share from the database.

Since:

v3.13

Method Summary

Modifier and Type	Method and Description
Long	getId() The identifier of the share.
String	getParam1() The first parameter of the permission.
String	getParam2() The second parameter of the permission.
default ShareRight	getRights() The rights for the permission.
ShareType.Name	getType() The type of the share (e.g.
default boolean	isEdit() Checks if share permission has view and edit right.
default boolean	isView() Checks if share permission has view right.

Method Detail

getId

Long getId()

The identifier of the share. Can be null if the share has not been stored.

Returns:

the identifier of the share.

getType

ShareType.Name getType()

The type of the share (e.g. group). Should never be null.

Returns:

the type of the share.

getParam1

String getParam1()

The first parameter of the permission. Its value can be null.

Returns:

the value of the permissions first parameter.

getParam2

String getParam2()

The second parameter of the permission. Its value can be null. This parameter cannot have a value when {#getParam1} returns null.

Returns:

the value of the permissions second parameter.

getRights

@ExperimentalApi
default ShareRight getRights()

The rights for the permission. Can store value if user is allowed to 'view' or 'view and edit'

Returns:

the value of the share rights.

Since:

v7.12

isView

@ExperimentalApi
default boolean isView()

Checks if share permission has view right.

Returns:

true if this share permission has view right

Since:

v7.12

isEdit

@ExperimentalApi
default boolean isEdit()

Checks if share permission has view and edit right.

Returns:

true if this share permission has view and edit right

Since:

v7.12