Interface | osid.course.chronicle.CredentialEntryAdminSession | ||
---|---|---|---|
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 | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCredentialEntries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CredentialEntry creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCredentialEntryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | credentialEntryRecordTypes | array of credential entry record types |
Return | boolean | true if CredentialEntry creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | credentialEntryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntryFormForCreate | ||
Description |
Gets the credential entry form for creating new credential entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | credentialId | a credential Id |
osid.id.Id | resourceId | a student Id | |
osid.type.Type[] | credentialEntryRecordTypes | array of credential entry record types | |
Return | osid.course.chronicle.CredentialEntryForm | the credential entry form | |
Errors | NOT_FOUND | credentialId or resourceId is not found | |
NULL_ARGUMENT | credentialId, resourceId , or
credentialEntryRecordTypes 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 | createCredentialEntry | ||
Description |
Creates a new | ||
Parameters | osid.course.chronicle.CredentialEntryForm | credentialEntryForm | the form for this CredentialEntry |
Return | osid.course.chronicle.CredentialEntry | the new CredentialEntry | |
Errors | ILLEGAL_STATE | credentialEntryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | credentialEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialEntryForm did not originate from
getCredentialEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCredentialEntries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if CredentialEntry modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntryFormForUpdate | ||
Description |
Gets the credential entry form for updating an existing credential entry. A new credential entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | credentialEntryId | the Id of the CredentialEntry |
Return | osid.course.chronicle.CredentialEntryForm | the credential entry form | |
Errors | NOT_FOUND | credentialEntryId is not found | |
NULL_ARGUMENT | credentialEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCredentialEntry | ||
Description |
Updates an existing credential entry. | ||
Parameters | osid.course.chronicle.CredentialEntryForm | credentialEntryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | credentialEntryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | credentialEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialEntryForm did not originate from
getCredentialEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCredentialEntries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CredentialEntry deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredentialEntry | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | credentialEntryId | the Id of the CredentialEntry to remove |
Errors | NOT_FOUND | credentialEntryId not found | |
NULL_ARGUMENT | credentialEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCredentialEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CredentialEntry aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCredentialEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | credentialEntryId | the Id of a CredentialEntry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | credentialEntryId not found | ||
NULL_ARGUMENT | credentialEntryId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |