Interface IssueProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply IssueProcessorEnablers to IssueProcessors. Multiple IssueProcessorEnablers applied to an IssueProcessor may be sequenced such that the first positive evaluation results in the IssueProcessorEnabler used.

Method Summary

Modifier and Type	Method	Description
void	assignIssueProcessorEnablerToIssueProcessor(Id issueProcessorEnablerId, Id issueProcessorId)	Adds an existing IssueProcessorEnabler to an IssueProcessor.
boolean	canAssignIssueProcessorEnablers()	Tests if this user can alter issue processor enabler/issue processor mappings.
boolean	canSequenceIssueProcessorEnablers()	Tests if this user can order IssueProcessorEnablers.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	moveIssueProcessorEnablerAhead(Id issueProcessorEnablerId, Id issueProcessorId, Id referenceId)	Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler in front of a reference issue processor enabler.
void	moveIssueProcessorEnablerBehind(Id issueProcessorEnablerId, Id issueProcessorId, Id referenceId)	Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler behind a reference issue processor enabler.
void	orderIssueProcessorEnablers(Id[] issueProcessorEnablerIds, Id issueProcessorId)	Reorders a set of issue processor enablers for an issue processor.
void	unassignIssueProcessorEnablerFromIssueProcessor(Id issueProcessorEnablerId, Id issueProcessorId)	Removes an existing IssueProcessorEnabler from an IssueProcessor.

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.

canAssignIssueProcessorEnablers

boolean canAssignIssueProcessorEnablers()

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

assignIssueProcessorEnablerToIssueProcessor

void assignIssueProcessorEnablerToIssueProcessor(Id issueProcessorEnablerId,
 Id issueProcessorId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing IssueProcessorEnabler to an IssueProcessor.

Parameters:

issueProcessorEnablerId - the Id of the IssueProcessorEnabler

issueProcessorId - the Id of the IssueProcessor

Throws:

AlreadyExistsException - issueProcessorEnablerId already applied to issueProcessorId

NotFoundException - issueProcessorEnablerId or issueProcessorId not found

NullArgumentException - issueProcessorEnablerId or issueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIssueProcessorEnablerFromIssueProcessor

void unassignIssueProcessorEnablerFromIssueProcessor(Id issueProcessorEnablerId,
 Id issueProcessorId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing IssueProcessorEnabler from an IssueProcessor.

Parameters:

issueProcessorEnablerId - the Id of the IssueProcessorEnabler

issueProcessorId - the Id of the IssueProcessor

Throws:

NotFoundException - issueProcessorEnablerId or issueProcessorId not found or issueProcessorEnablerId already applied to issueProcessorId

NullArgumentException - issueProcessorEnablerId or issueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceIssueProcessorEnablers

boolean canSequenceIssueProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveIssueProcessorEnablerAhead

void moveIssueProcessorEnablerAhead(Id issueProcessorEnablerId,
 Id issueProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

issueProcessorEnablerId - the Id of the IssueProcessorEnabler

issueProcessorId - the Id of the IssueProcessor

referenceId - the reference issue processor enabler Id

Throws:

NotFoundException - issueProcessorEnablerId issueProcessorId, or referenceId not found or, issueProcessorEnablerId or referenceId not related to issueProcessorId

NullArgumentException - issueProcessorEnablerId, issueProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveIssueProcessorEnablerBehind

void moveIssueProcessorEnablerBehind(Id issueProcessorEnablerId,
 Id issueProcessorId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

issueProcessorEnablerId - the Id of the IssueProcessorEnabler

issueProcessorId - the Id of the IssueProcessor

referenceId - the reference issue processor Id

Throws:

NotFoundException - issueProcessorEnablerId issueProcessorId, or referenceId not found or, issueProcessorEnablerId or referenceId not related to issueProcessorId

NullArgumentException - issueProcessorEnablerId, issueProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderIssueProcessorEnablers

void orderIssueProcessorEnablers(Id[] issueProcessorEnablerIds,
 Id issueProcessorId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of issue processor enablers for an issue processor.

Parameters:

issueProcessorEnablerIds - the Ids for a set of IssueProcessorEnablers

issueProcessorId - the Id of the IssueProcessor

Throws:

NotFoundException - issueProcessorId not found or, an issueProcessorEnablerId not related to issueProcessorId

NullArgumentException - issueProcessorEnablerIds or issueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.