Interface CommissionEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CommissionEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CommissionEnablers to Commissions . A Commission with multiple CommissionEnablers means any positive rule evaluation across the enablers result in an accessible Commission .

Method Summary

Modifier and Type	Method	Description
void	assignCommissionEnablerToCommission(Id commissionEnablerId, Id commissionId)	Adds an existing CommissionEnabler to a Commission .
boolean	canAssignCommissionEnablers()	Tests if this user can alter commission enabler/commission mappings.
boolean	canSequenceCommissionEnablers()	Tests if this user can order CommissionEnablers .
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	moveCommissionEnablerAhead(Id commissionEnablerId, Id commissionId, Id referenceId)	Reorders commission enablers for a commission by moving the specified commission enabler in front of a reference commission enabler.
void	moveCommissionEnablerBehind(Id commissionEnablerId, Id commissionId, Id referenceId)	Reorders commission enablers for a commission by moving the specified commission enabler behind a reference commission enabler.
void	orderCommissionEnablers(Id[] commissionEnablerIds, Id commissionId)	Reorders a set of commission enablers for a commission.
void	unassignCommissionEnablerFromCommission(Id commissionEnablerId, Id commissionId)	Removes a CommissionEnabler from a Commission .

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

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
            throws OperationFailedException,
PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignCommissionEnablers

boolean canAssignCommissionEnablers()

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

assignCommissionEnablerToCommission

void assignCommissionEnablerToCommission(Id commissionEnablerId,
 Id commissionId)
                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CommissionEnabler to a Commission .

Parameters:

commissionEnablerId - the Id of the CommissionEnabler

commissionId - the Id of the Commission

Throws:

AlreadyExistsException - commissionEnablerId is already applied to commissionId

NotFoundException - commissionEnablerId or commissionId not found

NullArgumentException - commissionEnablerId or commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCommissionEnablerFromCommission

void unassignCommissionEnablerFromCommission(Id commissionEnablerId,
 Id commissionId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CommissionEnabler from a Commission .

Parameters:

commissionEnablerId - the Id of the CommissionEnabler

commissionId - the Id of the Commission

Throws:

NotFoundException - commissionEnablerId or commissionId not found or commissionEnablerId not applied to commissionId

NullArgumentException - commissionEnablerId or commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCommissionEnablers

boolean canSequenceCommissionEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveCommissionEnablerAhead

void moveCommissionEnablerAhead(Id commissionEnablerId,
 Id commissionId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders commission enablers for a commission by moving the specified commission enabler in front of a reference commission enabler.

Parameters:

commissionEnablerId - the Id of a CommissionEnabler

commissionId - the Id of a Commission

referenceId - the reference commission enabler Id

Throws:

NotFoundException - commissionEnablerId, commissionId , or referenceId not found or, commissionEnablerId or referenceId not related to commissionId

NullArgumentException - commissionEnablerId,commissionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCommissionEnablerBehind

void moveCommissionEnablerBehind(Id commissionEnablerId,
 Id commissionId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

commissionEnablerId - the Id of a CommissionEnabler

commissionId - the Id of a Commission

referenceId - the reference commission enabler Id

Throws:

NotFoundException - commissionEnablerId, commissionId , or referenceId not found or, commissionEnablerId or referenceId not related to commissionId

NullArgumentException - commissionEnablerId,commissionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCommissionEnablers

void orderCommissionEnablers(Id[] commissionEnablerIds,
 Id commissionId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of commission enablers for a commission.

Parameters:

commissionEnablerIds - the Ids for a set of CommissionnEnablers

commissionId - the Id of a Commission

Throws:

NotFoundException - commissionId not found or, a commissionEnablerId not related to commissionId

NullArgumentException - commissionEnablerIds or commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.