Interface CatalogAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogAssignmentSession
extends OsidSession

This session provides methods to assign OSID Ids to Catalogs . An Id may appear in multiple Catalogs and removing the last reference to an Id is the equivalent of deleting it. Each catalog may have its own authorizations as to who is allowed to operate on it.

Method Summary

Modifier and Type	Method	Description
void	assignIdToCatalog(Id id, Id catalogId)	Adds an Id to a Catalog .
boolean	canAssignCatalogs()	Tests if this user can perform alter Id/Catalog mappings.
void	reassignIdToCatalog(Id id, Id fromCatalogId, Id toCatalogId)	Moves an Id from one Catalog to another.
void	unassignIdFromCatalog(Id id, Id catalogId)	Removes an Id from a Catalog .

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

canAssignCatalogs

boolean canAssignCatalogs()

Tests if this user can perform alter Id/Catalog 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignIdToCatalog

void assignIdToCatalog(Id id,
 Id catalogId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Catalog .

Parameters:

id - an Id

catalogId - the Id of the Catalog

Throws:

AlreadyExistsException - id is already mapped to catalogId

NotFoundException - id or catalogId not found

NullArgumentException - id or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIdFromCatalog

void unassignIdFromCatalog(Id id,
 Id catalogId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Id from a Catalog .

Parameters:

id - an Id

catalogId - the Id of the Catalog

Throws:

NotFoundException - id or catalogId not found or id is not mapped to catalogId

NullArgumentException - id or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignIdToCatalog

void reassignIdToCatalog(Id id,
 Id fromCatalogId,
 Id toCatalogId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Id from one Catalog to another. Mappings to other Catalogs are unaffected.

Parameters:

id - the Id

fromCatalogId - the Id of the current Catalog

toCatalogId - the Id of the destination Catalog

Throws:

AlreadyExistsException - id already assigned to toCatalogId

NotFoundException - id, fromCatalogId , or toCatalogId not found or id not mapped to fromCatalogId

NullArgumentException - id, fromCatalogId , or toCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.