org.osid.resourcing.rules

Interface AvailabilityEnablerFoundryAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AvailabilityEnablerFoundryAssignmentSession
extends OsidSession

This session provides methods to re-assign AvailabilityEnabler to Foundry mappings. an AvailabilityEnabler may appear in multiple Foundry objects and removing the last reference to an AvailabilityEnabler 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 AvailabilityEnabler to another Foundry is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAvailabilityEnablerToFoundry(Id availabilityEnablerId, Id foundryId) Adds an existing AvailabilityEnabler to a Foundry.
boolean	canAssignAvailabilityEnablers() Tests if this user can alter availability enabler/foundry mappings.
boolean	canAssignAvailabilityEnablersToFoundry(Id foundryId) Tests if this user can alter availability enabler/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any availability enabler can be assigned.
IdList	getAssignableFoundryIdsForAvailabilityEnabler(Id foundryId, Id availabilityEnablerId) Gets a list of foundries including and under the given foundry node in which a specific availability enabler can be assigned.
void	unassignAvailabilityEnablerFromFoundry(Id availabilityEnablerId, Id foundryId) Removes an AvailabilityEnabler from a Foundry.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignAvailabilityEnablers

boolean canAssignAvailabilityEnablers()

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

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignAvailabilityEnablersToFoundry

boolean canAssignAvailabilityEnablersToFoundry(Id foundryId)

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

getAssignableFoundryIdsForAvailabilityEnabler

IdList getAssignableFoundryIdsForAvailabilityEnabler(Id foundryId,
                                                   Id availabilityEnablerId)
                                                     throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

availabilityEnablerId - the Id of the AvailabilityEnabler

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or availabilityEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAvailabilityEnablerToFoundry

void assignAvailabilityEnablerToFoundry(Id availabilityEnablerId,
                                      Id foundryId)
                                        throws AlreadyExistsException,
                                               NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Adds an existing AvailabilityEnabler to a Foundry.

Parameters:

availabilityEnablerId - the Id of the AvailabilityEnabler

foundryId - the Id of the Foundry

Throws:

AlreadyExistsException - availabilityEnablerId is already assigned to foundryId

NotFoundException - availabilityEnablerId or foundryId not found

NullArgumentException - availabilityEnablerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAvailabilityEnablerFromFoundry

void unassignAvailabilityEnablerFromFoundry(Id availabilityEnablerId,
                                          Id foundryId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Removes an AvailabilityEnabler from a Foundry.

Parameters:

availabilityEnablerId - the Id of the AvailabilityEnabler

foundryId - the Id of the Foundry

Throws:

NotFoundException - availabilityEnablerId or foundryId not found or availabilityEnablerId not assigned to foundryId

NullArgumentException - availabilityEnablerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.