Interface | osid.inquiry.InquestAdminSession | ||
---|---|---|---|
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 | canCreateInquests | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Inquest creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInquestWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | inquestRecordTypes | array of inquest record types |
Return | boolean | true if Inquest creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | inquestRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquestFormForCreate | ||
Description |
Gets the inquest form for creating new inquests. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | inquestRecordTypes | array of inquest record types |
Return | osid.inquiry.InquestForm | the inquest form | |
Errors | NULL_ARGUMENT | inquestRecordTypes 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 | createInquest | ||
Description |
Creates a new | ||
Parameters | osid.inquiry.InquestForm | inquestForm | the form for this Inquest |
Return | osid.inquiry.Inquest | the new Inquest | |
Errors | ILLEGAL_STATE | inquestForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | inquestForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inquestForm did not originate from
getInquestFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateInquests | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Inquest modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquestFormForUpdate | ||
Description |
Gets the inquest form for updating an existing inquest. A new inquest form should be requested for each update transaction. | ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest |
Return | osid.inquiry.InquestForm | the inquest form | |
Errors | NOT_FOUND | inquestId is not found | |
NULL_ARGUMENT | inquestId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInquest | ||
Description |
Updates an existing inquest | ||
Parameters | osid.inquiry.InquestForm | inquestForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | inquestForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | inquestForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inquestForm did not originate from
getInquestFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInquests | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Inquest deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteInquest | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest to remove |
Errors | NOT_FOUND | inquestId not found | |
NULL_ARGUMENT | inquestId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInquestAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Inquest aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasInquest | ||
Description |
Adds an | ||
Parameters | osid.id.Id | inquestId | the Id of an Inquest |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | inquestId not found | ||
NULL_ARGUMENT | inquestId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |