org.osid.resourcing

Interface CommissionFoundryAssignmentSession

All Superinterfaces:

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

public interface CommissionFoundryAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCommissionToFoundry(Id commissionId, Id foundryId) Adds an existing Commission to a Foundry.
boolean	canAssignCommissions() Tests if this user can alter commission/foundry mappings.
boolean	canAssignCommissionsToFoundry(Id foundryId) Tests if this user can alter commission/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any commission can be assigned.
IdList	getAssignableFoundryIdsForCommission(Id foundryId, Id commissionId) Gets a list of foundries including and under the given foundry node in which a specific commission can be assigned.
void	unassignCommissionFromFoundry(Id commissionId, Id foundryId) Removes a Commission 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

canAssignCommissions

boolean canAssignCommissions()

Tests if this user can alter commission/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known availability 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignCommissionsToFoundry

boolean canAssignCommissionsToFoundry(Id foundryId)

Tests if this user can alter commission/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known availability 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 commission 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.

getAssignableFoundryIdsForCommission

IdList getAssignableFoundryIdsForCommission(Id foundryId,
                                          Id commissionId)
                                            throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

commissionId - the Id of the Commission

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or commissionId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCommissionToFoundry

void assignCommissionToFoundry(Id commissionId,
                             Id foundryId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing Commission to a Foundry.

Parameters:

commissionId - the Id of the Commission

foundryId - the Id of the Foundry

Throws:

NotFoundException - commissionId or foundryId not found

NullArgumentException - commissionId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCommissionFromFoundry

void unassignCommissionFromFoundry(Id commissionId,
                                 Id foundryId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a Commission from a Foundry.

Parameters:

commissionId - the Id of the Commission

foundryId - the Id of the Foundry

Throws:

NotFoundException - commissionId or foundryId not found

NullArgumentException - commissionId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.