Interface ProvisionEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProvisionEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ProvisionEnablers to Provisions. Multiple ProvisionEnablers applied to an Provision may be sequenced such that the first positive evaluation results in the ProvisionEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignProvisionEnablerToProvision(Id provisionEnablerId, Id provisionId)	Adds an existing ProvisionEnabler to a Provision.
boolean	canAssignProvisionEnablers()	Tests if this user can alter provision enabler/provision mappings.
boolean	canSequenceProvisionEnablers()	Tests if this user can order ProvisionEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveProvisionEnablerAhead(Id provisionEnablerId, Id provisionId, Id referenceId)	Reorders provision enablers for a provision by moving the specified provision enabler in front of a reference provision enabler.
void	moveProvisionEnablerBehind(Id provisionEnablerId, Id provisionId, Id referenceId)	Reorders provision enablers for a provision by moving the specified provision enabler behind a reference provision enabler.
void	orderProvisionEnablers(Id[] provisionEnablerIds, Id provisionId)	Reorders a set of provision enablers for a provision.
void	unassignProvisionEnablerFromProvision(Id provisionEnablerId, Id provisionId)	Removes an existing ProvisionEnabler from a Provision.

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

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignProvisionEnablers

boolean canAssignProvisionEnablers()

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

assignProvisionEnablerToProvision

void assignProvisionEnablerToProvision(Id provisionEnablerId,
 Id provisionId)
                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProvisionEnabler to a Provision.

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

provisionId - the Id of the Provision

Throws:

AlreadyExistsException - provisionEnablerId already applied to provisionId

NotFoundException - provisionEnablerId or provisionId not found

NullArgumentException - provisionEnablerId or provisionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProvisionEnablerFromProvision

void unassignProvisionEnablerFromProvision(Id provisionEnablerId,
 Id provisionId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProvisionEnabler from a Provision.

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

provisionId - the Id of the Provision

Throws:

NotFoundException - provisionEnablerId or provisionId not found or provisionEnablerId already applied to provisionId

NullArgumentException - provisionEnablerId or provisionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProvisionEnablers

boolean canSequenceProvisionEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveProvisionEnablerAhead

void moveProvisionEnablerAhead(Id provisionEnablerId,
 Id provisionId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

provisionId - the Id of the Provision

referenceId - the reference provision enabler Id

Throws:

NotFoundException - provisionEnablerId, provisionId, or referenceId not found or, provisionEnablerId or referenceId not related to provisionId

NullArgumentException - provisionEnablerId, provisionId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProvisionEnablerBehind

void moveProvisionEnablerBehind(Id provisionEnablerId,
 Id provisionId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

provisionId - the Id of the Provision

referenceId - the reference provision enabler Id

Throws:

NotFoundException - provisionEnablerId, provisionId, or referenceId not found or, provisionEnablerId or referenceId not related to provisionId

NullArgumentException - provisionEnablerId, provisionId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProvisionEnablers

void orderProvisionEnablers(Id[] provisionEnablerIds,
 Id provisionId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of provision enablers for a provision.

Parameters:

provisionEnablerIds - the Ids for a set of ProvisionEnablers

provisionId - the Id of the Provision

Throws:

NotFoundException - provisionEnablerId, provisionId, or referenceId not found or, provisionEnablerId or referenceId not related to provisionId

NullArgumentException - provisionEnablerIds, provisionId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.