OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogAssignmentSession
Implementsosid.OsidSession
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.

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
CompliancemandatoryThis method must be implemented.
MethodassignIdToCatalog
Description

Adds an Id to a Catalog.

Parametersosid.id.Ididan Id
osid.id.IdcatalogIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignIdFromCatalog
Description

Removes an Id from a Catalog.

Parametersosid.id.Ididan Id
osid.id.IdcatalogIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignIdToCatalog
Description

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

Parametersosid.id.Ididthe Id
osid.id.IdfromCatalogIdthe Id of the current Catalog
osid.id.IdtoCatalogIdthe Id of the destination Catalog
ErrorsNOT_FOUND id, fromCatalogId, or toCatalogId not found or id not mapped to fromCatalogId
NULL_ARGUMENT id, fromCatalogId, or toCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.