Interface HoldEnablerOublietteAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface HoldEnablerOublietteAssignmentSession
extends OsidSession

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

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

Method Summary

Modifier and Type	Method	Description
void	assignHoldEnablerToOubliette(Id holdEnablerId, Id oublietteId)	Adds an existing HoldEnabler to a Oubliette .
boolean	canAssignHoldEnablers()	Tests if this user can alter hold enabler/oubliette mappings.
boolean	canAssignHoldEnablersToOubliette(Id oublietteId)	Tests if this user can alter hold enabler/oubliette mappings.
IdList	getAssignableOublietteIds(Id oublietteId)	Gets a list of oubliettes including and under the given oubliette node in which any oubliette enabler can be assigned.
IdList	getAssignableOublietteIdsForHoldEnabler(Id oublietteId, Id holdEnablerId)	Gets a list of oubliettes including and under the given oubliette node in which a specific oubliette enabler can be assigned.
void	reassignHoldEnablerToOubliette(Id holdEnablerId, Id fromOublietteId, Id toOublietteId)	Moves a HoldEnabler from one Oubliette to another.
void	unassignHoldEnablerFromOubliette(Id holdEnablerId, Id oublietteId)	Removes a HoldEnabler from a Oubliette .

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

canAssignHoldEnablers

boolean canAssignHoldEnablers()

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

canAssignHoldEnablersToOubliette

boolean canAssignHoldEnablersToOubliette(Id oublietteId)

Tests if this user can alter hold enabler/oubliette 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:

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 oubliette enabler can be assigned.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

list of assignable hold Ids

Throws:

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableOublietteIdsForHoldEnabler

IdList getAssignableOublietteIdsForHoldEnabler(Id oublietteId,
 Id holdEnablerId)
                                        throws OperationFailedException

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

Parameters:

oublietteId - the Id of the Oubliette

holdEnablerId - the Id of the HoldEnabler

Returns:

list of assignable oubliette Ids

Throws:

NullArgumentException - oublietteId or holdEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignHoldEnablerToOubliette

void assignHoldEnablerToOubliette(Id holdEnablerId,
 Id oublietteId)
                           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing HoldEnabler to a Oubliette .

Parameters:

holdEnablerId - the Id of the HoldEnabler

oublietteId - the Id of the Oubliette

Throws:

AlreadyExistsException - holdEnablerId is already assigned to oublietteId

NotFoundException - holdEnablerId or oublietteId not found

NullArgumentException - holdEnablerId or oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignHoldEnablerFromOubliette

void unassignHoldEnablerFromOubliette(Id holdEnablerId,
 Id oublietteId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a HoldEnabler from a Oubliette .

Parameters:

holdEnablerId - the Id of the HoldEnabler

oublietteId - the Id of the Oubliette

Throws:

NotFoundException - holdEnablerId or oublietteId not found or holdEnablerId is not assigned to oublietteId

NullArgumentException - holdEnablerId or oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignHoldEnablerToOubliette

void reassignHoldEnablerToOubliette(Id holdEnablerId,
 Id fromOublietteId,
 Id toOublietteId)
                             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

holdEnablerId - the Id of the HoldEnabelr

fromOublietteId - the Id of the current Oubliette

toOublietteId - the Id of the destination Oubliette

Throws:

AlreadyExistsException - holdEnablerId already assigned to toOublietteId

NotFoundException - holdEnabler, fromOublietteId , or toOublietteId not found or holdEnablerId not mapped to fromOublietteId

NullArgumentException - holdEnablerId, fromOublietteId , or toOublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.