OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes todo producers. The data for create and update is provided via the TodoProducerForm.

MethodgetChecklistId
Description

Gets the Checklist Id associated with this session.

Returnosid.id.Idthe Checklist Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetChecklist
Description

Gets the Checklist associated with this session.

Returnosid.checklist.Checklistthe checklist
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateTodoProducer
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.

Returnboolean false if TodoProducer creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateTodoProducerWithRecordTypes
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.

Parametersosid.type.Type[]todoProducerRecordTypesarray of todo producer record types
Returnboolean true if TodoProducer creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT todoProducerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerFormForCreate
Description

Gets the todo producer form for creating new todo producers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]todoProducerRecordTypesarray of todo producer record types
Returnosid.checklist.mason.TodoProducerFormthe todo producer form
ErrorsNULL_ARGUMENT todoProducerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateTodoProducer
Description

Creates a new TodoProducer.

Parametersosid.checklist.mason.TodoProducerFormtodoProducerFormthe form for this TodoProducer
Returnosid.checklist.mason.TodoProducerthe new TodoProducer
ErrorsILLEGAL_STATE todoProducerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT todoProducerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED todoProducerForm did not originate from getTodoProducerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateTodoProducers
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.

Returnboolean false if TodoProducer modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerFormForUpdate
Description

Gets the todo producer form for updating an existing todo producer. A new todo producer form should be requested for each update transaction.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer
Returnosid.checklist.mason.TodoProducerFormthe todo producer form
ErrorsNOT_FOUND todoProducerId is not found
NULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTodoProducer
Description

Updates an existing todo producer.

Parametersosid.checklist.mason.TodoProducerFormtodoProducerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE todoProducerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT todoProducerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED todoProducerForm did not originate from getTodoProducerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteTodoProducers
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.

Returnboolean false if TodoProducer deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteTodoProducer
Description

Deletes a TodoProducer.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer to remove
ErrorsNOT_FOUND todoProducerId not found
NULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageTodoProducerAliases
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.

Returnboolean false if TodoProducer aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasTodoProducer
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.

Parametersosid.id.IdtodoProducerIdthe Id of a TodoProducer
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND todoProducerId not found
NULL_ARGUMENT todoProducerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.