Interface | osid.offering.CatalogueLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupCatalogues | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCatalogueView | ||
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 | usePlenaryCatalogueView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | Id of the Catalogue |
Return | osid.offering.Catalogue | the catalogue | |
Errors | NOT_FOUND | catalogueId not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCataloguesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | catalogueIds | the list of Ids to retrieve |
Return | osid.offering.CatalogueList | the returned Catalogue list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | catalogueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCataloguesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | catalogueGenusType | a catalogue genus type |
Return | osid.offering.CatalogueList | the returned Catalogue list | |
Errors | NULL_ARGUMENT | catalogueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCataloguesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | catalogueGenusType | a catalogue genus type |
Return | osid.offering.CatalogueList | the returned Catalogue list | |
Errors | NULL_ARGUMENT | catalogueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCataloguesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | catalogueRecordType | a catalogue record type |
Return | osid.offering.CatalogueList | the returned Catalogue list | |
Errors | NULL_ARGUMENT | catalogueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCataloguesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.offering.CatalogueList | the returned Catalogue list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogues | ||
Description |
Gets all | ||
Return | osid.offering.CatalogueList | a list of Catalogues | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |