Interface IssueEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignIssueEnablerToIssue(Id issueEnablerId, Id issueId)	Adds an existing IssueEnabler to an Issue.
boolean	canAssignIssueEnablers()	Tests if this user can alter issue enabler/issue mappings.
boolean	canSequenceIssueEnablers()	Tests if this user can order IssueEnablers.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	moveIssueEnablerAhead(Id issueEnablerId, Id issueId, Id referenceId)	Reorders issue enablers for an issue by moving the specified issue enabler in front of a reference issue enabelrs.
void	moveIssueEnablerBehind(Id issueEnablerId, Id issueId, Id referenceId)	Reorders issue enablers for an issue by moving the specified issue enabler behind a reference issue enabler.
void	orderIssueEnablers(Id[] issueEnablerIds, Id issueId)	Reorders a set of issue enablers for an issue.
void	unassignIssueEnablerFromIssue(Id issueEnablerId, Id issueId)	Removes an existing IssueEnabler 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.

canAssignIssueEnablers

boolean canAssignIssueEnablers()

Tests if this user can alter issue enabler/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.

assignIssueEnablerToIssue

void assignIssueEnablerToIssue(Id issueEnablerId,
 Id issueId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing IssueEnabler to an Issue.

Parameters:

issueEnablerId - the Id of the IssueEnabler

issueId - the Id of the Issue

Throws:

AlreadyExistsException - issueEnablerId already applied to issueId

NotFoundException - issueEnablerId or issueId not found

NullArgumentException - issueEnablerId or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIssueEnablerFromIssue

void unassignIssueEnablerFromIssue(Id issueEnablerId,
 Id issueId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing IssueEnabler from an Issue.

Parameters:

issueEnablerId - the Id of the IssueEnabler

issueId - the Id of the Issue

Throws:

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

NullArgumentException - issueEnablerId or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceIssueEnablers

boolean canSequenceIssueEnablers()

Tests if this user can order IssueEnablers. 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 IssueEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveIssueEnablerAhead

void moveIssueEnablerAhead(Id issueEnablerId,
 Id issueId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders issue enablers for an issue by moving the specified issue enabler in front of a reference issue enabelrs.

Parameters:

issueEnablerId - the Id of the IssueEnabler

issueId - the Id of the Issue

referenceId - the reference issue enabler Id

Throws:

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

NullArgumentException - issueEnablerId, issueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveIssueEnablerBehind

void moveIssueEnablerBehind(Id issueEnablerId,
 Id issueId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders issue enablers for an issue by moving the specified issue enabler behind a reference issue enabler.

Parameters:

issueEnablerId - the Id of the IssueEnabler

issueId - the Id of the Issue

referenceId - the reference issue enabler Id

Throws:

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

NullArgumentException - issueEnablerId, issueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderIssueEnablers

void orderIssueEnablers(Id[] issueEnablerIds,
 Id issueId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of issue enablers for an issue.

Parameters:

issueEnablerIds - the Ids for a set of IssueEnablers

issueId - the Id of the Issue

Throws:

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

NullArgumentException - issueEnablerIds or issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.