Interface IssueConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueConstrainerEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignIssueConstrainerEnablerToIssueConstrainer(Id issueConstrainerEnablerId, Id issueConstrainerId)	Adds an existing IssueConstrainerEnabler to an IssueConstrainer.
boolean	canAssignIssueConstrainerEnablers()	Tests if this user can alter issue constrainer enabler/issue constrainer mappings.
boolean	canSequenceIssueConstrainerEnablers()	Tests if this user can order IssueConstrainerEnablers.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	moveIssueConstrainerEnablerAhead(Id issueConstrainerEnablerId, Id issueConstrainerId, Id referenceId)	Reorders issue constrainer enablers for an issue constrainer by moving the specified issue constrainer enabler in front of a reference issue constrainer enabler.
void	moveIssueConstrainerEnablerBehind(Id issueConstrainerEnablerId, Id issueConstrainerId, Id referenceId)	Reorders issue constrainer enablers for an issue constrainer by moving the specified issue constrainer enabler behind a reference issue constrainer enabler.
void	orderIssueConstrainerEnablers(Id[] issueConstrainerEnablerIds, Id issueConstrainerId)	Reorders a set of issue constrainer enablers for an issue constrainer.
void	unassignIssueConstrainerEnablerFromIssueConstrainer(Id issueConstrainerEnablerId, Id issueConstrainerId)	Removes an existing IssueConstrainerEnabler from an IssueConstrainer.

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.

canAssignIssueConstrainerEnablers

boolean canAssignIssueConstrainerEnablers()

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

assignIssueConstrainerEnablerToIssueConstrainer

void assignIssueConstrainerEnablerToIssueConstrainer(Id issueConstrainerEnablerId,
 Id issueConstrainerId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing IssueConstrainerEnabler to an IssueConstrainer.

Parameters:

issueConstrainerEnablerId - the Id of the IssueConstrainerEnabler

issueConstrainerId - the Id of the IssueConstrainer

Throws:

AlreadyExistsException - issueConstrainerEnablerId already applied to issueConstrainerId

NotFoundException - issueConstrainerEnablerId or issueConstrainerId not found

NullArgumentException - issueConstrainerEnablerId or issueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIssueConstrainerEnablerFromIssueConstrainer

void unassignIssueConstrainerEnablerFromIssueConstrainer(Id issueConstrainerEnablerId,
 Id issueConstrainerId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing IssueConstrainerEnabler from an IssueConstrainer.

Parameters:

issueConstrainerEnablerId - the Id of the IssueConstrainerEnabler

issueConstrainerId - the Id of the IssueConstrainer

Throws:

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

NullArgumentException - issueConstrainerEnablerId or issueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceIssueConstrainerEnablers

boolean canSequenceIssueConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveIssueConstrainerEnablerAhead

void moveIssueConstrainerEnablerAhead(Id issueConstrainerEnablerId,
 Id issueConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

issueConstrainerEnablerId - the Id of the IssueConstrainerEnabler

issueConstrainerId - the Id of the IssueConstrainer

referenceId - the reference issue constrainer enabler Id

Throws:

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

NullArgumentException - issueConstrainerEnablerId, issueConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveIssueConstrainerEnablerBehind

void moveIssueConstrainerEnablerBehind(Id issueConstrainerEnablerId,
 Id issueConstrainerId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

issueConstrainerEnablerId - the Id of the IssueConstrainerEnabler

issueConstrainerId - the Id of the IssueConstrainer

referenceId - the reference issue constrainer Id

Throws:

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

NullArgumentException - issueConstrainerEnablerId, issueConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderIssueConstrainerEnablers

void orderIssueConstrainerEnablers(Id[] issueConstrainerEnablerIds,
 Id issueConstrainerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

issueConstrainerEnablerIds - the Ids for a set of IssueConstrainerEnablers

issueConstrainerId - the Id of the IssueConstrainer

Throws:

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

NullArgumentException - issueConstrainerEnablerIds or issueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.