Interface BranchedIssueAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BranchedIssueAdminSession
extends OsidSession

This session branches issues.

Method Summary

Modifier and Type	Method	Description
Issue	branchIssue(Id issueId)	Branches an Issue .
boolean	canBranchIssues()	Tests if this user can branch Issues .
void	copyLogEntry(Id branchedIssueId, Id logEntryId)	Copies a log entry from the root issue to be visible in the branched issue.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
void	removeLogEntry(Id branchedIssueId, Id logEntryId)	Removes a log entry from the branch issue.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                    throws OperationFailedException,
PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canBranchIssues

boolean canBranchIssues()

Tests if this user can branch 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 branching operations to an unauthorized user.

Returns:

false if Issue branching is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

branchIssue

Issue branchIssue(Id issueId)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Branches an Issue . The new issue is initialized with all the data from the root issue except for the log entries.

Parameters:

issueId - the Id of the Issue

Returns:

the new Issue

Throws:

NotFoundException - issueId not found

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - 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 - the Id of the Issue

logEntryId - the Id of the Issue

Throws:

AlreadyExistsException - branchedIssueId already has logEntryId

NotFoundException - branchedIssueId or logEntryId not found

NullArgumentException - branchedIssueId or logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - 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 - the Id of the Issue

logEntryId - the Id of the Issue

Throws:

NotFoundException - logEntryId is not in branchedIssueId

NullArgumentException - branchedIssueId or logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.