OSID - osid.checklist.mason.TodoProducerAdminSession Service Interface Definition

Interface	osid.checklist.mason.TodoProducerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.checklist.mason.ChecklistMasonManager`
Used By	`osid.checklist.mason.ChecklistMasonProxyManager`
Description	This session creates and removes todo producers. The data for create and update is provided via the `TodoProducerForm`.
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	canCreateTodoProducer
Description	Tests if this user can create todo producers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `TodoProducer` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `TodoProducer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTodoProducerWithRecordTypes
Description	Tests if this user can create a single `TodoProducer` using the desired record types. While `ChecklistMasonManager.getTodoProducerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `TodoProducer`. Providing an empty array tests if a `TodoProducer` can be created with no records.
Parameters	`osid.type.Type[]`	`todoProducerRecordTypes`	array of todo producer record types
Return	`boolean`		`true` if `TodoProducer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`todoProducerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerFormForCreate
Description	Gets the todo producer form for creating new todo producers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`todoProducerRecordTypes`	array of todo producer record types
Return	`osid.checklist.mason.TodoProducerForm`		the todo producer form
Errors	NULL_ARGUMENT		`todoProducerRecordTypes` 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	createTodoProducer
Description	Creates a new `TodoProducer`.
Parameters	`osid.checklist.mason.TodoProducerForm`	`todoProducerForm`	the form for this `TodoProducer`
Return	`osid.checklist.mason.TodoProducer`		the new `TodoProducer`
Errors	ILLEGAL_STATE		`todoProducerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`todoProducerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoProducerForm` did not originate from `getTodoProducerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTodoProducers
Description	Tests if this user can update todo producers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `TodoProducer` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `TodoProducer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerFormForUpdate
Description	Gets the todo producer form for updating an existing todo producer. A new todo producer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`todoProducerId`	the `Id` of the `TodoProducer`
Return	`osid.checklist.mason.TodoProducerForm`		the todo producer form
Errors	NOT_FOUND		`todoProducerId` is not found
	NULL_ARGUMENT		`todoProducerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateTodoProducer
Description	Updates an existing todo producer.
Parameters	`osid.checklist.mason.TodoProducerForm`	`todoProducerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`todoProducerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`todoProducerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoProducerForm` did not originate from `getTodoProducerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTodoProducers
Description	Tests if this user can delete todo producers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `TodoProducer` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `TodoProducer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteTodoProducer
Description	Deletes a `TodoProducer`.
Parameters	`osid.id.Id`	`todoProducerId`	the `Id` of the `TodoProducer` to remove
Errors	NOT_FOUND		`todoProducerId` not found
	NULL_ARGUMENT		`todoProducerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTodoProducerAliases
Description	Tests if this user can manage `Id` aliases for todo producers. 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 `TodoProducer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasTodoProducer
Description	Adds an `Id` to a `TodoProducer` for the purpose of creating compatibility. The primary `Id` of the `TodoProducer` 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 producer. it is reassigned to the given todo producer `Id`.
Parameters	`osid.id.Id`	`todoProducerId`	the `Id` of a `TodoProducer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`todoProducerId` not found
	NULL_ARGUMENT		`todoProducerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.