Interface BranchedIssueAdminSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session branches issues.
-
Method Summary
Modifier and TypeMethodDescriptionbranchIssue(Id issueId) Branches anIssue.booleanTests if this user can branchIssues.voidcopyLogEntry(Id branchedIssueId, Id logEntryId) Copies a log entry from the root issue to be visible in the branched issue.Gets theFrontOfficeassociated with this session.Gets theFrontOfficeIdassociated with this session.voidremoveLogEntry(Id branchedIssueId, Id logEntryId) Removes a log entry from the branch issue.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getFrontOfficeId
Id getFrontOfficeId()Gets theFrontOfficeIdassociated with this session.- Returns:
- the
FrontOffice Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getFrontOffice
Gets theFrontOfficeassociated with this session.- Returns:
- the front office
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canBranchIssues
boolean canBranchIssues()Tests if this user can branchIssues. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a subtask will result in aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer branching operations to an unauthorized user.- Returns:
falseifIssuebranching is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
branchIssue
Issue branchIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException Branches anIssue. The new issue is initialized with all the data from the root issue except for the log entries.- Parameters:
issueId- theIdof theIssue- Returns:
- the new
Issue - Throws:
NotFoundException-issueIdnot foundNullArgumentException-issueIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
copyLogEntry
void copyLogEntry(Id branchedIssueId, Id logEntryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Copies a log entry from the root issue to be visible in the branched issue.- Parameters:
branchedIssueId- theIdof theIssuelogEntryId- theIdof theIssue- Throws:
AlreadyExistsException-branchedIssueIdalready haslogEntryIdNotFoundException-branchedIssueIdorlogEntryIdnot foundNullArgumentException-branchedIssueIdorlogEntryIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeLogEntry
void removeLogEntry(Id branchedIssueId, Id logEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a log entry from the branch issue.- Parameters:
branchedIssueId- theIdof theIssuelogEntryId- theIdof theIssue- Throws:
NotFoundException-logEntryIdis not inbranchedIssueIdNullArgumentException-branchedIssueIdorlogEntryIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-