Interface AvailabilityFoundryAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AvailabilityFoundryAssignmentSession
extends OsidSession

This session provides methods to re-assign Availabilities to Foundry mappings. An Availability may appear in multiple Foundry objects and removing the last reference to an Availability is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Availability to another Foundry is not a copy operation (eg: does not change its Id ).

Method Summary

Modifier and Type	Method	Description
void	assignAvailabilityToFoundry(Id availabilityId, Id foundryId)	Adds an existing Availability to a Foundry .
boolean	canAssignAvailabilities()	Tests if this user can alter availability/foundry mappings.
boolean	canAssignAvailabilitiesToFoundry(Id foundryId)	Tests if this user can alter availability/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId)	Gets a list of foundries including and under the given foundry node in which any availability can be assigned.
IdList	getAssignableFoundryIdsForAvailability(Id foundryId, Id availabilityId)	Gets a list of foundries including and under the given foundry node in which a specific availability can be assigned.
void	reassignAvailabilityToFoundry(Id availabilityId, Id fromFoundryId, Id toFoundryId)	Moves an Availability from one Foundry to another.
void	unassignAvailabilityFromFoundry(Id availabilityId, Id foundryId)	Removes an Availability from a Foundry .

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

canAssignAvailabilities

boolean canAssignAvailabilities()

Tests if this user can alter availability/foundry 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 assignment operations to unauthorized users.

Returns:

false if availability is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignAvailabilitiesToFoundry

boolean canAssignAvailabilitiesToFoundry(Id foundryId)

Tests if this user can alter availability/foundry 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 assignment operations to unauthorized users.

Parameters:

foundryId - the Id of the Foundry

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIds

IdList getAssignableFoundryIds(Id foundryId)
                        throws OperationFailedException

Gets a list of foundries including and under the given foundry node in which any availability can be assigned.

Parameters:

foundryId - the Id of the Foundry

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIdsForAvailability

IdList getAssignableFoundryIdsForAvailability(Id foundryId,
 Id availabilityId)
                                       throws OperationFailedException

Gets a list of foundries including and under the given foundry node in which a specific availability can be assigned.

Parameters:

foundryId - the Id of the Foundry

availabilityId - the Id of the Availability

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or availabilityId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAvailabilityToFoundry

void assignAvailabilityToFoundry(Id availabilityId,
 Id foundryId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Availability to a Foundry .

Parameters:

availabilityId - the Id of the Availability

foundryId - the Id of the Foundry

Throws:

NotFoundException - availabilityId or foundryId not found

NullArgumentException - availabilityId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAvailabilityFromFoundry

void unassignAvailabilityFromFoundry(Id availabilityId,
 Id foundryId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Availability from a Foundry .

Parameters:

availabilityId - the Id of the Availability

foundryId - the Id of the Foundry

Throws:

NotFoundException - availabilityId or foundryId not found

NullArgumentException - availabilityId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignAvailabilityToFoundry

void reassignAvailabilityToFoundry(Id availabilityId,
 Id fromFoundryId,
 Id toFoundryId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Availability from one Foundry to another. Mappings to other Foundries are unaffected.

Parameters:

availabilityId - the Id of the Availability

fromFoundryId - the Id of the current Foundry

toFoundryId - the Id of the destination Foundry

Throws:

AlreadyExistsException - availabilityId already assigned to toFoundryId

NotFoundException - availabilityId, fromFoundryId , or toFoundryId not found or availabilityId not mapped to fromFoundryId

NullArgumentException - availabilityId, fromFoundryId , or toFoundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.