Interface | osid.inquiry.AuditLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupAudits | ||
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 | useComparativeAuditView | ||
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 | usePlenaryAuditView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedInquestView | ||
Description |
Federates the view for methods in this session. A federated view will include audit constrainers in inquests which are children of this inquest in the inquest hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedInquestView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveAuditView | ||
Description |
Only active audits are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusAuditView | ||
Description |
Borth active and inactive audits are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAudit | ||
Description |
Gets the In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.id.Id | auditId | Id of the Audit |
Return | osid.inquiry.Audit | the audit | |
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 is must be implemented. | |
Method | getAuditsByIds | ||
Description |
Gets an In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.id.IdList | auditIds | the list of Ids to retrieve |
Return | osid.inquiry.AuditList | the returned Audit list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | auditIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditsByGenusType | ||
Description |
Gets an In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.type.Type | auditGenusType | an audit genus type |
Return | osid.inquiry.AuditList | the returned Audit list | |
Errors | NULL_ARGUMENT | auditGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditsByParentGenusType | ||
Description |
Gets an In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.type.Type | auditGenusType | an audit genus type |
Return | osid.inquiry.AuditList | the returned Audit list | |
Errors | NULL_ARGUMENT | auditGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditsByRecordType | ||
Description |
Gets an In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.type.Type | auditRecordType | an audit record type |
Return | osid.inquiry.AuditList | the returned Audit list | |
Errors | NULL_ARGUMENT | auditRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditsByProvider | ||
Description |
Gets an In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.inquiry.AuditList | the returned Audit 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 | getAudits | ||
Description |
Gets all In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session. In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned. | ||
Return | osid.inquiry.AuditList | a list of Audits | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |