Interface | osid.inquiry.AuditAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getInquestId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Inquest Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquest | ||
Description |
Gets the | ||
Return | osid.inquiry.Inquest | the inquest | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAudit | ||
Description |
Tests if this user can create audits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known creating an | ||
Return | boolean | false if Audit creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuditWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | auditRecordTypes | array of audit record types |
Return | boolean | true if Audit creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | auditRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditFormForCreate | ||
Description |
Gets the audit form for creating new audits. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | auditRecordTypes | array of audit record types |
Return | osid.inquiry.AuditForm | the audit form | |
Errors | NULL_ARGUMENT | auditRecordTypes 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 | createAudit | ||
Description |
Creates a new | ||
Parameters | osid.inquiry.AuditForm | auditForm | the form for this Audit |
Return | osid.inquiry.Audit | the new Audit | |
Errors | ILLEGAL_STATE | auditForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | auditForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auditForm did not originate from
getAuditFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAudits | ||
Description |
Tests if this user can update audits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating an | ||
Return | boolean | false if Audit modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditFormForUpdate | ||
Description |
Gets the audit form for updating an existing audit. A new audit form should be requested for each update transaction. | ||
Parameters | osid.id.Id | auditId | the Id of the Audit |
Return | osid.inquiry.AuditForm | the audit form | |
Errors | NOT_FOUND | auditId is not found | |
NULL_ARGUMENT | auditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAudit | ||
Description |
Updates an existing audit. | ||
Parameters | osid.inquiry.AuditForm | auditForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | auditForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | auditForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auditForm did not originate from
getAuditFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAudits | ||
Description |
Tests if this user can delete audits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting an | ||
Return | boolean | false if Audit deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAudit | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | auditId | the Id of the Audit to remove |
Errors | NOT_FOUND | auditId not found | |
NULL_ARGUMENT | auditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAuditAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Audit aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAudit | ||
Description |
Adds an | ||
Parameters | osid.id.Id | auditId | the Id of an Audit |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | auditId not found | ||
NULL_ARGUMENT | auditId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |