Interface | osid.offering.CanonicalUnitLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving canonical units. This lookup session defines several views:
The methods | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupCanonicalUnits | ||
Description |
Tests if this user can examine this catalogue. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known all methods in
this session will result in a | ||
Return | boolean | false if catalogue reading methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCanonicalUnitView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCanonicalUnitView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include canonical units in catalogues which are children of this catalogue in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveCanonicalUnitView | ||
Description |
Only active canonical units are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusCanonicalUnitView | ||
Description |
Active and inactive canonical units are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCanonicalUnit | ||
Description |
Gets the In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit to retrieve |
Return | osid.offering.CanonicalUnit | the returned CanonicalUnit | |
Errors | NOT_FOUND | no CanonicalUnit found with the given Id | |
NULL_ARGUMENT | canonicalUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsByIds | ||
Description |
Gets a In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | osid.id.IdList | canonicalUnitIds | the list of Ids to retrieve |
Return | osid.offering.CanonicalUnitList | the returned CanonicalUnit list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | canonicalUnitIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsByGenusType | ||
Description |
Gets a In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | osid.type.Type | canonicalUnitGenusType | a canonical units genus type |
Return | osid.offering.CanonicalUnitList | the returned CanonicalUnit list | |
Errors | NULL_ARGUMENT | canonicalUnitGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsByParentGenusType | ||
Description |
Gets a In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | osid.type.Type | canonicalUnitGenusType | a canonical unit genus type |
Return | osid.offering.CanonicalUnitList | the returned CanonicalUnit list | |
Errors | NULL_ARGUMENT | canonicalUnitGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known canonical units or an error results. Otherwise, the returned list may contain only those canonical units that are accessible through this session. In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | osid.type.Type | canonicalUnitRecordType | a canonical unit record type |
Return | osid.offering.CanonicalUnitList | the returned CanonicalUnitList | |
Errors | NULL_ARGUMENT | canonicalUnitRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsByCode | ||
Description |
Gets canonical units by code. In plenary mode, the returned list contains all known canonical units or an error results. Otherwise, the returned list may contain only those canonical units that are accessible through this session. In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Parameters | string | code | a code |
Return | osid.offering.CanonicalUnitList | a list of canonical units | |
Errors | NULL_ARGUMENT | code is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnits | ||
Description |
Gets all canonical units. In plenary mode, the returned list contains all known canonical units or an error results. Otherwise, the returned list may contain only those canonical units that are accessible through this session. In active mode, canonicals are returned that are currently active. In any status mode, active and inactive canonicals are returned. | ||
Return | osid.offering.CanonicalUnitList | a list of canonical units | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |