public interface BlockingIssueAdminSession extends OsidSession
This session blocks issues.
Modifier and Type | Method and Description |
---|---|
void |
blockIssue(Id blockedIssueId,
Id blockingIssueId)
Blocks an
Issue. |
boolean |
canBlockIssue(Id issueId)
Tests if this user can block an
Issue. |
boolean |
canBlockIssues()
Tests if this user can block
Issues. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
void |
unblockIssue(Id blockedIssueId,
Id blockingIssueId)
Unblocks an
Issue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canBlockIssues()
Issues.
A return of true
does not guarantee successful authorization. A return of false
indicates that it is known creating a subtask will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer blocking operations to an
unauthorized user. false
if Issue
blocking is not
authorized, true
otherwisemandatory
- This method must be implemented. boolean canBlockIssue(Id issueId)
Issue.
A return of true
does not guarantee successful authorization. A return of false
indicates that it is known creating the subtask will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer blocking operations to an
unauthorized user.issueId
- the Id
of the Issue
false
if issue blocking is not authorized,
true
otherwiseNullArgumentException
- issueId
is
null
mandatory
- This method must be implemented. If
- the issueId
is not found, then it is
acceptable to return false to indicate the lack of create
available. void blockIssue(Id blockedIssueId, Id blockingIssueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Issue.
blockedIssueId
- the Id
of the blocked
Issue
blockingIssueId
- the Id
of the blocking
Issue
AlreadyExistsException
- blockingIssueId
already blocking blockedIssueId
NotFoundException
- blockedIssueId
or
blockingIssueId
not foundNullArgumentException
- blockedIssueId
or blockingIssueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unblockIssue(Id blockedIssueId, Id blockingIssueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Issue.
blockedIssueId
- the Id
of the blocked
Issue
blockingIssueId
- the Id
of the blocking
Issue
NotFoundException
- blockedIssueId
is
not blocked by blockingIssueId
NullArgumentException
- blockedIssueId
or blockingIssueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.