org.osid.hold

Interface HoldOublietteAssignmentSession

All Superinterfaces:

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

public interface HoldOublietteAssignmentSession
extends OsidSession

This session provides methods to re-assign Holds to Oubliette mappings. A Hold may appear in multiple Oubliette objects and removing the last reference to a Hold is the equivalent of deleting it. Each Oubliette may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Hold to another Oubliette is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignHoldToOubliette(Id holdId, Id oublietteId) Adds an existing Hold to a Oubliette.
boolean	canAssignHolds() Tests if this user can alter hold/oubliette mappings.
boolean	canAssignHoldsToOubliette(Id oublietteId) Tests if this user can alter hold/oubliette mappings.
IdList	getAssignableOublietteIds(Id oublietteId) Gets a list of oubliettes including and under the given oubliette node in which any hold can be assigned.
IdList	getAssignableOublietteIdsForHold(Id oublietteId, Id holdId) Gets a list of oubliettes including and under the given oubliette node in which a specific hold can be assigned.
void	reassignHoldToOubliette(Id holdId, Id fromOublietteId, Id toOublietteId) Moves a Hold from one Oubliette to another.
void	unassignHoldFromOubliette(Id holdId, Id oublietteId) Removes a Hold from a Oubliette.

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

canAssignHolds

boolean canAssignHolds()

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

canAssignHoldsToOubliette

boolean canAssignHoldsToOubliette(Id oublietteId)

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

oublietteId - the Id of the Oubliette

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

getAssignableOublietteIds

IdList getAssignableOublietteIds(Id oublietteId)
                                 throws OperationFailedException

Gets a list of oubliettes including and under the given oubliette node in which any hold can be assigned.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

list of assignable oubliette Ids

Throws:

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableOublietteIdsForHold

IdList getAssignableOublietteIdsForHold(Id oublietteId,
                                      Id holdId)
                                        throws OperationFailedException

Gets a list of oubliettes including and under the given oubliette node in which a specific hold can be assigned.

Parameters:

oublietteId - the Id of the Oubliette

holdId - the Id of the Hold

Returns:

list of assignable oubliette Ids

Throws:

NullArgumentException - oublietteId or holdId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignHoldToOubliette

void assignHoldToOubliette(Id holdId,
                         Id oublietteId)
                           throws AlreadyExistsException,
                                  NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Adds an existing Hold to a Oubliette.

Parameters:

holdId - the Id of the Hold

oublietteId - the Id of the Oubliette

Throws:

AlreadyExistsException - holdId is already assigned to oublietteId

NotFoundException - holdId or oublietteId not found

NullArgumentException - holdId or oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignHoldFromOubliette

void unassignHoldFromOubliette(Id holdId,
                             Id oublietteId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Removes a Hold from a Oubliette.

Parameters:

holdId - the Id of the Hold

oublietteId - the Id of the Oubliette

Throws:

NotFoundException - holdId or oublietteId not found or holdId not assigned to oublietteId

NullArgumentException - holdId or oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignHoldToOubliette

void reassignHoldToOubliette(Id holdId,
                           Id fromOublietteId,
                           Id toOublietteId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Moves a Hold from one Oubliette to another. Mappings to other Oubliettes are unaffected.

Parameters:

holdId - the Id of the Hold

fromOublietteId - the Id of the current Oubliette

toOublietteId - the Id of the destination Oubliette

Throws:

NotFoundException - holdId, fromOublietteId, or toOublietteId not found or holdId not mapped to fromOublietteId

NullArgumentException - holdId, fromOublietteId, or toOublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.