| Interface | osid.inquiry.rules.InquiryEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to apply   | ||
| 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 | canAssignInquiryEnablers | ||
| Description | 
                     Tests if this user can alter inquiry enabler/inquiry 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                      | ||
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | assignInquiryEnablerToInquiry | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | inquiryEnablerId | the  Id  of the  InquiryEnabler   | 
osid.id.Id | inquiryId | the  Id  of the  Inquiry   | |
| Errors | ALREADY_EXISTS |  inquiryEnablerId  already applied to  inquiryId   |                 |
| NOT_FOUND |  inquiryEnablerId  or  inquiryId  not found  |                 ||
| NULL_ARGUMENT |  inquiryEnablerId  or  inquiryId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignInquiryEnablerFromInquiry | ||
| Description | 
                     Removes an   | ||
| Parameters | osid.id.Id | inquiryEnablerId | the  Id  of the  InquiryEnabler   | 
osid.id.Id | inquiryId | the  Id  of the  Inquiry   | |
| Errors | NOT_FOUND |  inquiryEnablerId  or  inquiryId  not found or 
 inquiryEnablerId  not applied to  inquiryId   |                 |
| NULL_ARGUMENT |  inquiryEnablerId  or  inquiryId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceInquiryEnablers | ||
| Description | 
                     Tests if this user can order   | ||
| Return | boolean |  false  if  InquiryEnabler  ordering is not 
authorized,  true  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveInquiryEnablerAhead | ||
| Description | 
                     Reorders inquiry enablers for an inquiry by moving the specified inquiry enabler in front of a reference inquiry enabler.  | ||
| Parameters | osid.id.Id | inquiryEnablerId | the  Id  of an  InquiryEnabler   | 
osid.id.Id | inquiryId | the  Id  of an  Inquiry   | |
osid.id.Id | referenceId | the reference inquiry enabler  Id   | |
| Errors | NOT_FOUND |  inquiryEnablerId, inquiryId,  or  referenceId  
not found or,  inquiryEnablerId  or  referenceId  
not related to  inquiryId   |                 |
| NULL_ARGUMENT |  inquiryEnablerId, inquiryId,  or  referenceId  
is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveInquiryEnablerBehind | ||
| Description | 
                     Reorders inquiry enablers for an inquiry by moving the specified inquiry enabler behind a reference inquiry enabler.  | ||
| Parameters | osid.id.Id | inquiryEnablerId | the  Id  of an  InquiryEnabler   | 
osid.id.Id | inquiryId | the  Id  of an  Inquiry   | |
osid.id.Id | referenceId | the reference inquiry enabler  Id   | |
| Errors | NOT_FOUND |  inquiryEnablerId, inquiryId,  or  referenceId  
not found or,  inquiryEnablerId  or  referenceId  
not related to  inquiryId   |                 |
| NULL_ARGUMENT |  inquiryEnablerId, inquiryId,  or  referenceId  
is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderInquiryEnablers | ||
| Description | 
                     Reorders a set of inquiry enablers for an inquiry.  | ||
| Parameters | osid.id.Id[] | inquiryEnablerIds | the  Ids  for a set of  InquiryEnablers   | 
osid.id.Id | inquiryId | the  Id  of an  Inquiry   | |
| Errors | NOT_FOUND |  inquiryConstraienrId  not found or, an  
inquiryEnablerId  not related to  inquiryId   |                 |
| NULL_ARGUMENT |  inquiryEnablerIds  or  inquiryId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |