Interface | osid.hold.IssueAdminSession | ||
---|---|---|---|
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 | getOublietteId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Oubliette Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOubliette | ||
Description |
Gets the | ||
Return | osid.hold.Oubliette | the oubliette | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateIssues | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Issue creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateIssueWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | issueRecordTypes | array of issue record types |
Return | boolean | true if Issue creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | issueRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueFormForCreate | ||
Description |
Gets the issue form for creating new issues. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | issueRecordTypes | array of issue record types |
Return | osid.hold.IssueForm | the issue form | |
Errors | NULL_ARGUMENT | issueRecordTypes 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 | createIssue | ||
Description |
Creates a new | ||
Parameters | osid.hold.IssueForm | issueForm | the form for this Issue |
Return | osid.hold.Issue | the new Issue | |
Errors | ILLEGAL_STATE | issueForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | issueForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | issueForm did not originate from
getIssueFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateIssues | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Issue modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueFormForUpdate | ||
Description |
Gets the issue form for updating an existing issue. A new issue form should be requested for each update transaction. | ||
Parameters | osid.id.Id | issueId | the Id of the Issue |
Return | osid.hold.IssueForm | the issue form | |
Errors | NOT_FOUND | issueId is not found | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIssue | ||
Description |
Updates an existing issue. | ||
Parameters | osid.hold.IssueForm | issueForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | issueForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | issueId or issueForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | issueForm did not originate from
getIssueFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteIssues | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Issue deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteIssue | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | issueId | the Id of the Issue to remove |
Errors | NOT_FOUND | issueId not found | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageIssueAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Issue aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasIssue | ||
Description |
Adds an | ||
Parameters | osid.id.Id | issueId | the Id of an Issue |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | issueId not found | ||
NULL_ARGUMENT | issueId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |