OSID - osid.checklist.TodoAdminSession Service Interface Definition

Interface	osid.checklist.TodoAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Todos.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Todo,` an `TodoForm` is requested using `getTodoFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `TodoForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `TodoForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `TodoForm` corresponds to an attempted transaction. For updates, `TodoForms` are requested to the `Todo` `Id` that is to be updated using `getTodoFormForUpdate().` Similarly, the `TodoForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `TodoForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Todos.` To unmap an `Todo` from the current `Checklist,` the `TodoChecklistAssignmentSession` should be used. These delete operations attempt to remove the `Bid` itself thus removing it from all known `Checklist` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getChecklistId
Description	Gets the `Checklist` `Id` associated with this session.
Return	`osid.id.Id`		the `Checklist Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getChecklist
Description	Gets the `Checklist` associated with this session.
Return	`osid.checklist.Checklist`		the checklist
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTodos
Description	Tests if this user can create todos. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Todo` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Todo` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTodoWithRecordTypes
Description	Tests if this user can create a single `Todo` using the desired record types. While `ChecklistManager.getTodoRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Todo.` Providing an empty array tests if a `Todo` can be created with no records.
Parameters	`osid.type.Type[]`	`todoRecordTypes`	array of todo record types
Return	`boolean`		`true` if `Todo` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`todoRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTodoFormForCreate
Description	Gets the todo form for creating new todos. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`todoRecordTypes`	array of todo record types
Return	`osid.checklist.TodoForm`		the todo form
Errors	NULL_ARGUMENT		`todoRecordTypes` 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	createTodo
Description	Creates a new `Todo.`
Parameters	`osid.checklist.TodoForm`	`todoForm`	the form for this `Todo`
Return	`osid.checklist.Todo`		the new `Todo`
Errors	ILLEGAL_STATE		`todoForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`todoForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoForm` did not originate from `getTodoFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTodos
Description	Tests if this user can update todos. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Todo` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Todo` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTodoFormForUpdate
Description	Gets the todo form for updating an existing todo. A new todo form should be requested for each update transaction.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo`
Return	`osid.checklist.TodoForm`		the todo form
Errors	NOT_FOUND		`todoId` is not found
	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateTodo
Description	Updates an existing todo.
Parameters	`osid.checklist.TodoForm`	`todoForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`todoForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`todoId` or `todoForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoForm` did not originate from `getTodoFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTodos
Description	Tests if this user can delete todos. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Todo` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Todo` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteTodo
Description	Deletes a `Todo.`
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` to remove
Errors	NOT_FOUND		`todoId` not found
	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTodoAliases
Description	Tests if this user can manage `Id` aliases for `Comnents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Todo` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasTodo
Description	Adds an `Id` to a `Todo` for the purpose of creating compatibility. The primary `Id` of the `Todo` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another todo, it is reassigned to the given todo `Id.`
Parameters	`osid.id.Id`	`todoId`	the `Id` of a `Todo`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`todoId` not found
	NULL_ARGUMENT		`todoId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDependencies
Description	Tests if this user can manage todo dependencies `.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Todo` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addDependency
Description	Adds a todo as a dependency for another todo.
Parameters	`osid.id.Id`	`dependentTodoId`	the `Id` of the dependency `Todo`
Parameters	`osid.id.Id`	`dependencyTodoId`	the `Id` of the `Todo` dependency
Errors	ALREADY_EXISTS		`dependentTodoId` is already dependent upon `dependencyTodoId` or vice-versa
	NOT_FOUND		`dependentTodoId` or `dependencyTodoId` is not found
	NULL_ARGUMENT		`dependentTodoId` or `dependencyTodoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeDependency
Description	Removes a todo as a dependency from another todo.
Parameters	`osid.id.Id`	`dependentTodoId`	the `Id` of the dependency `Todo`
Parameters	`osid.id.Id`	`dependencyTodoId`	the `Id` of the `Todo` dependency
Errors	NOT_FOUND		`dependentTodoId` or `dependencyTodoId` is not found, or `dependentTodoId` not dependent upon `dependencyTodoId`
	NULL_ARGUMENT		`dependentTodoId` or `dependencyTodoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.