Interface ProvisionableEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProvisionableEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ProvisionableEnablers to Provisionables. Multiple ProvisionableEnablers applied to an Provisionable may be sequenced such that the first positive evaluation results in the ProvisionableEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignProvisionableEnablerToProvisionable(Id provisionableEnablerId, Id provisionableId)	Adds an existing ProvisionableEnabler to a Provisionable.
boolean	canAssignProvisionableEnablers()	Tests if this user can alter provisionable enabler/provisionable mappings.
boolean	canSequenceProvisionableEnablers()	Tests if this user can order ProvisionableEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveProvisionableEnablerAhead(Id provisionableEnablerId, Id provisionableId, Id referenceId)	Reorders provisionable enablers for a provisionable by moving the specified provisionable enabler in front of a reference provisionable enabler.
void	moveProvisionableEnablerBehind(Id provisionableEnablerId, Id provisionableId, Id referenceId)	Reorders provisionable enablers for a provisionable by moving the specified provisionable enabler behind a reference provisionable enabler.
void	orderProvisionableEnablers(Id[] provisionableEnablerIds, Id provisionableId)	Reorders a set of provisionable enablers for a provisionable.
void	unassignProvisionableEnablerFromProvisionable(Id provisionableEnablerId, Id provisionableId)	Removes an existing ProvisionableEnabler from a Provisionable.

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.

canAssignProvisionableEnablers

boolean canAssignProvisionableEnablers()

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

assignProvisionableEnablerToProvisionable

void assignProvisionableEnablerToProvisionable(Id provisionableEnablerId,
 Id provisionableId)
                                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProvisionableEnabler to a Provisionable.

Parameters:

provisionableEnablerId - the Id of the ProvisionableEnabler

provisionableId - the Id of the Provisionable

Throws:

AlreadyExistsException - provisionableEnablerId already applied to provisionableId

NotFoundException - provisionableEnablerId or provisionableId not found

NullArgumentException - provisionableEnablerId or provisionableId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProvisionableEnablerFromProvisionable

void unassignProvisionableEnablerFromProvisionable(Id provisionableEnablerId,
 Id provisionableId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProvisionableEnabler from a Provisionable.

Parameters:

provisionableEnablerId - the Id of the ProvisionableEnabler

provisionableId - the Id of the Provisionable

Throws:

NotFoundException - provisionableEnablerId or provisionableId not found or provisionableEnablerId already applied to provisionableId

NullArgumentException - provisionableEnablerId or provisionableId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProvisionableEnablers

boolean canSequenceProvisionableEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveProvisionableEnablerAhead

void moveProvisionableEnablerAhead(Id provisionableEnablerId,
 Id provisionableId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionableEnablerId - the Id of the ProvisionableEnabler

provisionableId - the Id of the Provisionable

referenceId - the reference provisionable enabler Id

Throws:

NotFoundException - provisionableEnablerId, provisionableId, or referenceId not found or, provisionableEnablerId or referenceId not related to provisionableId

NullArgumentException - provisionableEnablerId, provisionableId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProvisionableEnablerBehind

void moveProvisionableEnablerBehind(Id provisionableEnablerId,
 Id provisionableId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionableEnablerId - the Id of the ProvisionableEnabler

provisionableId - the Id of the Provisionable

referenceId - the reference provisionable enabler Id

Throws:

NotFoundException - provisionableEnablerId, provisionableId, or referenceId not found or, provisionableEnablerId or referenceId not related to provisionableId

NullArgumentException - provisionableEnablerId, provisionableId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProvisionableEnablers

void orderProvisionableEnablers(Id[] provisionableEnablerIds,
 Id provisionableId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of provisionable enablers for a provisionable.

Parameters:

provisionableEnablerIds - the Ids for a set of ProvisionableEnablers

provisionableId - the Id of the Provisionable

Throws:

NotFoundException - provisionableEnablerId, provisionableId, or referenceId not found or, provisionableEnablerId or referenceId not related to provisionableId

NullArgumentException - provisionableEnablerIds, provisionableId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.