com.almworks.jira.structure.api.permissions

Class PermissionRule.ApplyStructure

Object

PermissionRule

PermissionRule.ApplyStructure

All Implemented Interfaces:

Cloneable

Enclosing class:

PermissionRule

public static class PermissionRule.ApplyStructure
extends PermissionRule

This rules applies a list of rules taken from a Structure, identified by the structure ID.

See Also:

Structure

Nested Class Summary

Nested classes/interfaces inherited from class PermissionRule

PermissionRule.ApplyStructure, PermissionRule.SetLevel

Constructor Summary

Constructors

Constructor and Description
ApplyStructure()
ApplyStructure(Long structureId)

Method Summary

Modifier and Type	Method and Description
PermissionLevel	apply(ApplicationUser user, PermissionLevel pass, List<Object> callStack, La<Long,List<PermissionRule>> resolver) Apply permission rule and return the result.
boolean	equals(Object o)
Long	getStructureId()
int	hashCode()
void	setStructureId(Long structureId)
String	toEncodedString()

Methods inherited from class PermissionRule

clone, decodePermissions, encodePermissions, fromEncodedString, fromEncodedString, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplyStructure

public ApplyStructure()

ApplyStructure

public ApplyStructure(Long structureId)

Method Detail

getStructureId

public Long getStructureId()

setStructureId

public void setStructureId(Long structureId)

toEncodedString

public String toEncodedString()

Specified by:

toEncodedString in class PermissionRule

Returns:

a string representation of this permission rule

See Also:

PermissionRule.fromEncodedString(java.lang.String)

apply

@NotNull
public PermissionLevel apply(ApplicationUser user,
                                      @NotNull
                                      PermissionLevel pass,
                                      List<Object> callStack,
                                      La<Long,List<PermissionRule>> resolver)

Description copied from class: PermissionRule

Apply permission rule and return the result.

Normally you should not call this method directly - call Structure.getEffectivePermission() instead.

Specified by:

apply in class PermissionRule

Parameters:

user - the user, null means anonymous

pass - the default value, which is returned in case this rule does not apply

callStack - auxiliary container for objects used to check for recursive rules

resolver - auxiliary function that converts structure ID into associated list of permission rules - used by PermissionRule.ApplyStructure. If null, PermissionRule.ApplyStructure will not be able to apply and return pass value.

Returns:

permission level for the passed user

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object