OSID - osid.checklist.ChecklistProfile Service Interface Definition

Interface	osid.checklist.ChecklistProfile
Implements	`osid.OsidProfile`
Description	The todoing profile describes the interoperability among todoing services.
Method	supportsVisibleFederation
Description	Tests if any checklist federation is exposed. Federation is exposed when a specific checklist may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of checklists appears as a single checklist.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoLookup
Description	Tests for the availability of a todo lookup service.
Return	`boolean`		`true` if todo lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoQuery
Description	Tests if querying todos is available.
Return	`boolean`		`true` if todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoSearch
Description	Tests if searching for todos is available.
Return	`boolean`		`true` if todo search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoAdmin
Description	Tests if managing todos is available.
Return	`boolean`		`true` if todo admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoNotification
Description	Tests if todo notification is available.
Return	`boolean`		`true` if todo notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoHierarchy
Description	Tests if todo hierarchy traversal service is supported.
Return	`boolean`		`true` if todo hierarchy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoHierarchyDesign
Description	Tests if a todo hierarchy design service is supported.
Return	`boolean`		`true` if todo hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoChecklist
Description	Tests if a todo to checklist lookup session is available.
Return	`boolean`		`true` if todo checklist lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoChecklistAssignment
Description	Tests if a todo to checklist assignment session is available.
Return	`boolean`		`true` if todo checklist assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoSmartChecklist
Description	Tests if a todo smart checklisting session is available.
Return	`boolean`		`true` if todo smart checklisting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistLookup
Description	Tests for the availability of an checklist lookup service.
Return	`boolean`		`true` if checklist lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistQuery
Description	Tests if querying checklists is available.
Return	`boolean`		`true` if checklist query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistSearch
Description	Tests if searching for checklists is available.
Return	`boolean`		`true` if checklist search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistAdmin
Description	Tests for the availability of a checklist administrative service for creating and deleting checklists.
Return	`boolean`		`true` if checklist administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistNotification
Description	Tests for the availability of a checklist notification service.
Return	`boolean`		`true` if checklist notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsChecklistHierarchy
Description	Tests for the availability of a checklist hierarchy traversal service.
Return	`boolean`		`true` if checklist hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistHierarchyDesign
Description	Tests for the availability of a checklist hierarchy design service.
Return	`boolean`		`true` if checklist hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsChecklistBatch
Description	Tests for the availability of a checklist batch service.
Return	`boolean`		`true` if checklist batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsChecklistMason
Description	Tests for the availability of a checklist mason service.
Return	`boolean`		`true` if checklist mason service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getTodoRecordTypes
Description	Gets the supported `Todo` record types.
Return	`osid.type.TypeList`		a list containing the supported todo record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoRecordType
Description	Tests if the given `Todo` record type is supported.
Parameters	`osid.type.Type`	`todoRecordType`	a `Type` indicating a `Todo` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`todoRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTodoSearchRecordTypes
Description	Gets the supported todo search record types.
Return	`osid.type.TypeList`		a list containing the supported todo search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoSearchRecordType
Description	Tests if the given todo search record type is supported.
Parameters	`osid.type.Type`	`todoSearchRecordType`	a `Type` indicating a todo record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`todoSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistRecordTypes
Description	Gets the supported `Checklist` record types.
Return	`osid.type.TypeList`		a list containing the supported checklist record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistRecordType
Description	Tests if the given `Checklist` record type is supported.
Parameters	`osid.type.Type`	`checklistRecordType`	a `Type` indicating a `Checklist` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checklistRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistSearchRecordTypes
Description	Gets the supported checklist search record types.
Return	`osid.type.TypeList`		a list containing the supported checklist search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistSearchRecordType
Description	Tests if the given checklist search record type is supported.
Parameters	`osid.type.Type`	`checklistSearchRecordType`	a `Type` indicating a checklist record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checklistSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriorityTypes
Description	Gets the supported priority types.
Return	`osid.type.TypeList`		a list containing the supported priority types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriorityType
Description	Tests if the given priority type is supported.
Parameters	`osid.type.Type`	`priorityType`	a `Type` indicating a priority type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.