Interface | osid.cataloging.CatalogAdminSession | ||
---|---|---|---|
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 | canCreateCatalogs | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Catalog creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCatalogWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | catalogRecordTypes | array of catalog record types |
Return | boolean | true if Catalog creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | catalogRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogFormForCreate | ||
Description |
Gets the catalog form for creating new catalogs. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | catalogRecordTypes | array of catalog record types |
Return | osid.cataloging.CatalogForm | the catalog form | |
Errors | NULL_ARGUMENT | catalogRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCatalog | ||
Description |
Creates a new | ||
Parameters | osid.cataloging.CatalogForm | catalogForm | the form for this Catalog |
Return | osid.cataloging.Catalog | the new Catalog | |
Errors | ILLEGAL_STATE | catalogForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | catalogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogForm did not originate from
getCatalogFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCatalogs | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Catalog modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogFormForUpdate | ||
Description |
Gets the catalog form for updating an existing catalog. A new catalog form should be requested for each update transaction. | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
Return | osid.cataloging.CatalogForm | the catalog form | |
Errors | NOT_FOUND | catalogId is not found | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCatalog | ||
Description |
Updates an existing catalog. | ||
Parameters | osid.cataloging.CatalogForm | catalogForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | catalogForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | catalogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogForm did not originate from
getCatalogFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCatalogs | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Catalog deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCatalog | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog to remove |
Errors | NOT_FOUND | catalogId not found | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCatalogAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Catalog aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCatalog | ||
Description |
Adds an | ||
Parameters | osid.id.Id | catalogId | the Id of a Catalog |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | catalogId not found | ||
NULL_ARGUMENT | catalogId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |