Interface IssueConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply IssueConstrainers to Issues. Multiple IssueConstrainers applied to an Issue may be sequenced such that the first positive evaluation results in the IssueConstrainer used.

Method Summary

Modifier and Type	Method	Description
void	assignIssueConstrainerToIssue(Id issueConstrainerId, Id issueId)	Adds an existing IssueConstrainer to an Issue.
boolean	canAssignIssueConstrainers()	Tests if this user can alter issue constrainer/issue mappings.
boolean	canSequenceIssueConstrainers()	Tests if this user can order IssueConstrainers.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	moveIssueConstrainerAhead(Id issueConstrainerId, Id issueId, Id referenceId)	Reorders issue constrainers for an issue by moving the specified issue constrainer in front of a reference issue constrainer.
void	moveIssueConstrainerBehind(Id issueConstrainerId, Id issueId, Id referenceId)	Reorders issue constrainers for an issue by moving the specified issue constrainer behind a reference issue constrainer.
void	orderIssueConstrainers(Id[] issueConstrainerIds, Id issueId)	Reorders a set of issue constrainers for an issue.
void	unassignIssueConstrainerFromIssue(Id issueConstrainerId, Id issueId)	Removes an existing IssueConstrainer from an 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

getOublietteId

Id getOublietteId()

Gets the Oubliette Id associated with this session.

Returns:

the Oubliette Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOubliette

Oubliette getOubliette()
                throws OperationFailedException,
PermissionDeniedException

Gets the Oubliette associated with this session.

Returns:

the oubliette

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignIssueConstrainers

boolean canAssignIssueConstrainers()

Tests if this user can alter issue constrainer/issue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignIssueConstrainerToIssue

void assignIssueConstrainerToIssue(Id issueConstrainerId,
 Id issueId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing IssueConstrainer to an Issue.

Parameters:

issueConstrainerId - the Id of the IssueConstrainer

issueId - the Id of the Issue

Throws:

AlreadyExistsException - issueConstrainerId already applied to issueId

NotFoundException - issueConstrainerId or issueId not found

NullArgumentException - issueConstrainerId or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIssueConstrainerFromIssue

void unassignIssueConstrainerFromIssue(Id issueConstrainerId,
 Id issueId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing IssueConstrainer from an Issue.

Parameters:

issueConstrainerId - the Id of the IssueConstrainer

issueId - the Id of the Issue

Throws:

NotFoundException - issueConstrainerId or issueId not found or issueConstrainerId already applied to issueId

NullArgumentException - issueConstrainerId or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceIssueConstrainers

boolean canSequenceIssueConstrainers()

Tests if this user can order IssueConstrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if IssueConstrainer ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveIssueConstrainerAhead

void moveIssueConstrainerAhead(Id issueConstrainerId,
 Id issueId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders issue constrainers for an issue by moving the specified issue constrainer in front of a reference issue constrainer.

Parameters:

issueConstrainerId - the Id of the IssueConstrainer

issueId - the Id of the Issue

referenceId - the reference issue constrainer Id

Throws:

NotFoundException - issueConstrainerId, issueId , or referenceId not found or, issueConstrainerId or referenceId not related to issueId

NullArgumentException - issueConstrainerId, issueId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveIssueConstrainerBehind

void moveIssueConstrainerBehind(Id issueConstrainerId,
 Id issueId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders issue constrainers for an issue by moving the specified issue constrainer behind a reference issue constrainer.

Parameters:

issueConstrainerId - the Id of the IssueConstrainer

issueId - the Id of the Issue

referenceId - the reference issue constrainer Id

Throws:

NotFoundException - issueConstrainerId, issueId , or referenceId not found or, issueConstrainerId or referenceId not related to issueId

NullArgumentException - issueConstrainerId, issueId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderIssueConstrainers

void orderIssueConstrainers(Id[] issueConstrainerIds,
 Id issueId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of issue constrainers for an issue.

Parameters:

issueConstrainerIds - the Ids for a set of IssueConstrainers

issueId - the Id of the Issue

Throws:

NotFoundException - issueId not found or, an issueConstrainerId not related to issueId

NullArgumentException - issueConstrainerIds or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.