org.osid.cataloging

Interface CatalogAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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	unassignIdFromCatalog(Id id, Id catalogId) Removes an Id from a Catalog.

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

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.