com.atlassian.jira.permission
Interface PermissionContext

All Known Implementing Classes:
PermissionContextImpl

public interface PermissionContext

Represents the context in which a permission evaluation is to be made. Permission requests are of the form: subject, verb, object (eg. "User fred wishes to comment on ABC-123"), where: subject = User object verb = permission Id object = Issue, project etc. A PermissionContext encapsulates the object.

To create PermissionContext objects, use the PermissionContextFactory

See Also:
PermissionContextFactory

Method Summary
 Issue getIssue()
           
 org.ofbiz.core.entity.GenericValue getProject()
          Deprecated. Use getProjectObject() instead. Since v5.0.
 Project getProjectObject()
          Returns the Project in this context.
 com.opensymphony.workflow.loader.StepDescriptor getRelevantStepDescriptor()
          Returns the relevant workflow step for the Issue in this context
 Status getStatus()
           
 boolean hasIssuePermissions()
          Whether we have enough information to look up issue-specific (workflow) permissions.
 boolean isHasCreatedIssue()
          Deprecated. Use hasIssuePermissions() instead. Since v5.0.
 

Method Detail

getProject

org.ofbiz.core.entity.GenericValue getProject()
Deprecated. Use getProjectObject() instead. Since v5.0.

Returns the Project in this context.

Returns:
the Project in this context.

getProjectObject

Project getProjectObject()
Returns the Project in this context.

Returns:
the Project in this context.

getIssue

Issue getIssue()

isHasCreatedIssue

boolean isHasCreatedIssue()
Deprecated. Use hasIssuePermissions() instead. Since v5.0.

Whether this PermissionContext has an existing fully-formed issue (not one that is still being created). This returns false on the second issue creation page, and on the quick sub-task creation form, where the issue type is unknown.

Returns:
true if this PermissionContext has an existing fully-formed issue.

getStatus

Status getStatus()

getRelevantStepDescriptor

com.opensymphony.workflow.loader.StepDescriptor getRelevantStepDescriptor()
Returns the relevant workflow step for the Issue in this context

Returns:
the relevant workflow step for the Issue in this context

hasIssuePermissions

boolean hasIssuePermissions()
Whether we have enough information to look up issue-specific (workflow) permissions.

True if this PermissionContext has an existing fully-formed issue (not one that is still being created).

Returns:
true if this PermissionContext has an existing fully-formed issue.


Copyright © 2002-2012 Atlassian. All Rights Reserved.