Interface AvailabilityEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AvailabilityEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply AvailabilityEnablers to Availabilities. An Availability with multiple AvailabilityEnablers means any positive rule evaluation across the enablers result in an accessible Availability.

Method Summary

Modifier and Type	Method	Description
void	assignAvailabilityEnablerToAvailability(Id availabilityEnablerId, Id availabilityId)	Adds an existing AvailabilityEnabler to an Availability.
boolean	canAssignAvailabilityEnablers()	Tests if this user can alter availability enabler/availability mappings.
boolean	canSequenceAvailabilityEnablers()	Tests if this user can order AvailabilityEnablers.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	moveAvailabilityEnablerAhead(Id availabilityEnablerId, Id availabilityId, Id referenceId)	Reorders availability enablers for an availability by moving the specified availability enabler in front of a reference availability enabler.
void	moveAvailabilitynEnablerBehind(Id availabilityEnablerId, Id availabilityId, Id referenceId)	Reorders availability enablers for an availability by moving the specified availability enabler behind a reference availability enabler.
void	orderAvailabilityEnablers(Id[] availabilityEnablerIds, Id availabilityId)	Reorders a set of availability enablers for an availability.
void	unassignAvailabilityEnablerFromAvailability(Id availabilityEnablerId, Id availabilityId)	Removes an AvailabilityEnabler from an Availability.

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.

canAssignAvailabilityEnablers

boolean canAssignAvailabilityEnablers()

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

assignAvailabilityEnablerToAvailability

void assignAvailabilityEnablerToAvailability(Id availabilityEnablerId,
 Id availabilityId)
                                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AvailabilityEnabler to an Availability.

Parameters:

availabilityEnablerId - the Id of the AvailabilityEnabler

availabilityId - the Id of the Availability

Throws:

AlreadyExistsException - availabilityEnablerId is already applied to availabilityId

NotFoundException - availabilityEnablerId or availabilityId not found

NullArgumentException - availabilityEnablerId or availabilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAvailabilityEnablerFromAvailability

void unassignAvailabilityEnablerFromAvailability(Id availabilityEnablerId,
 Id availabilityId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AvailabilityEnabler from an Availability.

Parameters:

availabilityEnablerId - the Id of the AvailabilityEnabler

availabilityId - the Id of the Availability

Throws:

NotFoundException - availabilityEnablerId or availabilityId not found or availabilityEnablerId not applied to availabilityId

NullArgumentException - availabilityEnablerId or availabilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAvailabilityEnablers

boolean canSequenceAvailabilityEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveAvailabilityEnablerAhead

void moveAvailabilityEnablerAhead(Id availabilityEnablerId,
 Id availabilityId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

availabilityEnablerId - the Id of an AvailabilityEnabler

availabilityId - the Id of an Availability

referenceId - the reference availability enabler Id

Throws:

NotFoundException - availabilityEnablerId, availabilityId, or referenceId not found or, availabilityEnablerId or referenceId not related to availabilityId

NullArgumentException - availabilityEnablerId, availabilityId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAvailabilitynEnablerBehind

void moveAvailabilitynEnablerBehind(Id availabilityEnablerId,
 Id availabilityId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

availabilityEnablerId - the Id of an AvailabilityEnabler

availabilityId - the Id of an Availability

referenceId - the reference availability enabler Id

Throws:

NotFoundException - availabilityEnablerId, availabilityId, or referenceId not found or, availabilityEnablerId or referenceId not related to availabilityId

NullArgumentException - availabilityEnablerId, availabilityId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAvailabilityEnablers

void orderAvailabilityEnablers(Id[] availabilityEnablerIds,
 Id availabilityId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of availability enablers for an availability.

Parameters:

availabilityEnablerIds - the Ids for a set of AvailabilityEnablers

availabilityId - the Id of an Availability

Throws:

NotFoundException - availabilityId not found or, an availabilityEnablerId not related to availabilityId

NullArgumentException - availabilityEnablerIds or availabilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.