Interface | osid.offering.CatalogueAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateCatalogues | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Catalogue creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCatalogueWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | catalogueRecordTypes | array of types |
Return | boolean | true if Catalogue creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | catalogueRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueFormForCreate | ||
Description |
Gets the catalogue form for creating new catalogues. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | catalogueRecordTypes | array of types |
Return | osid.offering.CatalogueForm | the catalogue form | |
Errors | NULL_ARGUMENT | catalogueRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cannot get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCatalogue | ||
Description |
Creates a new | ||
Parameters | osid.offering.CatalogueForm | catalogueForm | the form for this Catalogue |
Return | osid.offering.Catalogue | the new Catalogue | |
Errors | ILLEGAL_STATE | catalogueForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | catalogueForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogueForm did not originate from
getCatalogueFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCatalogues | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Catalogue modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueFormForUpdate | ||
Description |
Gets the catalogue form for updating an existing catalogue. A new catalogue form should be requested for each update transaction. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.CatalogueForm | the catalogue form | |
Errors | NOT_FOUND | catalogueId is not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCatalogue | ||
Description |
Updates an existing catalogue. | ||
Parameters | osid.offering.CatalogueForm | catalogueForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | catalogueForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | catalogueForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogueForm did not originate from getCataloguetFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCatalogues | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Catalogue deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCatalogue | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue to remove |
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 must be implemented. | |
Method | canManageCatalogueAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Catalogue aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCatalogue | ||
Description |
Adds an | ||
Parameters | osid.id.Id | catalogueId | the Id of a Catalogue |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | catalogueId not found | ||
NULL_ARGUMENT | catalogueId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |