OSID Logo
OSID Specifications
cataloging package
Version 3.1.0
Interfaceosid.cataloging.CatalogAssignmentSession
Implementsosid.OsidSession
Used Byosid.cataloging.CatalogingManager
osid.cataloging.CatalogingProxyManager
Description

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.

Like all OsidSessions, CatalogAssignmentSessions are dedicated to single processing threads and a single authenticated user.

MethodcanAssignCatalogs
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodassignIdToCatalog
Description

Adds an Id to a Catalog.

Parametersosid.id.Idid an Id
osid.id.IdcatalogId the Id of the Catalog
ErrorsALREADY_EXISTS id is already mapped to catalogId
NOT_FOUND id or catalogId not found
NULL_ARGUMENT id or catalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignIdFromCatalog
Description

Removes an Id from a Catalog .

Parametersosid.id.Idid an Id
osid.id.IdcatalogId the Id of the Catalog
ErrorsNOT_FOUND id or catalogId not found or id is not mapped to catalogId
NULL_ARGUMENT id or catalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignIdToCatalog
Description

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

Parametersosid.id.Idid the Id
osid.id.IdfromCatalogId the Id of the current Catalog
osid.id.IdtoCatalogId the Id of the destination Catalog
ErrorsALREADY_EXISTS id already assigned to toCatalogId
NOT_FOUND id, fromCatalogId, or toCatalogId not found or id not mapped to fromCatalogId
NULL_ARGUMENT id, fromCatalogId, or toCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.