Interface | osid.assessment.authoring.SequenceRuleEnablerLookupSession | ||
---|---|---|---|
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 | getBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBank | ||
Description |
Gets the | ||
Return | osid.assessment.Bank | the bank | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSequenceRuleEnablers | ||
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 | useComparativeSequenceRuleEnablerView | ||
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 | usePlenarySequenceRuleEnablerView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBankView | ||
Description |
Federates the view for methods in this session. A federated view will include sequence rule enablers in banks which are children of this bank in the bank hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSequenceRuleEnablerView | ||
Description |
Only active sequence rule enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSequenceRuleEnablerView | ||
Description |
All active and inactive sequence rule enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSequenceRuleEnabler | ||
Description |
Gets the In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.id.Id | sequenceRuleEnablerId | Id of the SequenceRuleEnabler |
Return | osid.assessment.authoring.SequenceRuleEnabler | the sequence rule enabler | |
Errors | NOT_FOUND | sequenceRuleEnablerId not found | |
NULL_ARGUMENT | sequenceRuleEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSequenceRuleEnablersByIds | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.id.IdList | sequenceRuleEnablerIds | the list of Ids to retrieve |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | NOT_FOUND | a Id was not found | |
NULL_ARGUMENT | sequenceRuleEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablersByGenusType | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.type.Type | sequenceRuleEnablerGenusType | a sequence rule enabler genus type |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | NULL_ARGUMENT | sequenceRuleEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablersByParentGenusType | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.type.Type | sequenceRuleEnablerGenusType | a sequence rule enabler genus type |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | NULL_ARGUMENT | sequenceRuleEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablersByRecordType | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.type.Type | sequenceRuleEnablerRecordType | a sequence rule enabler record type |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | NULL_ARGUMENT | sequenceRuleEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablersOnDate | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | agentId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRuleEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned. | ||
Return | osid.assessment.authoring.SequenceRuleEnablerList | the returned SequenceRuleEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |