Interface ChecklistAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ChecklistBatchAdminSession

public interface ChecklistAdminSession
extends OsidSession

This session creates, updates, and deletes Checklists . 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 a Checklist , a ChecklistForm is requested using geChecklistFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ChecklistForm 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 ChecklistForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ChecklistForm corresponds to an attempted transaction.

For updates, ChecklistForms are requested to the Checklist Id that is to be updated using getChecklistFormForUpdate() . Similarly, the ChecklistForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ChecklistForm can only be used once for a successful update and cannot be reused.

The delete operations delete Checklists .

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasChecklist(Id checklistId, Id aliasId)	Adds an Id to a Checklist for the purpose of creating compatibility.
boolean	canCreateChecklists()	Tests if this user can create Checklists .
boolean	canCreateChecklistWithRecordTypes(Type[] checklistRecordTypes)	Tests if this user can create a single Checklist using the desired record types.
boolean	canDeleteChecklists()	Tests if this user can delete Checklists A return of true does not guarantee successful authorization.
boolean	canManageChecklistAliases()	Tests if this user can manage Id aliases for Checklists .
boolean	canUpdateChecklists()	Tests if this user can update Checklists .
Checklist	createChecklist(ChecklistForm checklistForm)	Creates a new Checklist .
void	deleteChecklist(Id checklistId)	Deletes a Checklist .
ChecklistForm	getChecklistFormForCreate(Type[] checklistRecordTypes)	Gets the checklist form for creating new checklists.
ChecklistForm	getChecklistFormForUpdate(Id checklistId)	Gets the checklist form for updating an existing checklist.
void	updateChecklist(ChecklistForm checklistForm)	Updates an existing checklist.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canCreateChecklists

boolean canCreateChecklists()

Tests if this user can create Checklists . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Checklist 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.

Returns:

false if Checklist creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateChecklistWithRecordTypes

boolean canCreateChecklistWithRecordTypes(Type[] checklistRecordTypes)

Tests if this user can create a single Checklist using the desired record types. While ChecklistManager.getChecklistRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Checklist . Providing an empty array tests if a Checklist can be created with no records.

Parameters:

checklistRecordTypes - array of checklist record types

Returns:

true if Checklist creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - checklistRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getChecklistFormForCreate

ChecklistForm getChecklistFormForCreate(Type[] checklistRecordTypes)
                                 throws OperationFailedException,
PermissionDeniedException

Gets the checklist form for creating new checklists. A new form should be requested for each create transaction.

Parameters:

checklistRecordTypes - array of checklist record types

Returns:

the checklist form

Throws:

NullArgumentException - checklistRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createChecklist

Checklist createChecklist(ChecklistForm checklistForm)
                   throws OperationFailedException,
PermissionDeniedException

Creates a new Checklist .

Parameters:

checklistForm - the form for this Checklist

Returns:

the new Checklist

Throws:

IllegalStateException - checklistForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - checklistForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - checklistForm did not originate from getChecklistFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateChecklists

boolean canUpdateChecklists()

Tests if this user can update Checklists . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Checklist 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.

Returns:

false if Checklist modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getChecklistFormForUpdate

ChecklistForm getChecklistFormForUpdate(Id checklistId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

checklistId - the Id of the Checklist

Returns:

the checklist form

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateChecklist

void updateChecklist(ChecklistForm checklistForm)
              throws OperationFailedException,
PermissionDeniedException

Updates an existing checklist.

Parameters:

checklistForm - the form containing the elements to be updated

Throws:

IllegalStateException - checklistForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - checklistForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - checklistForm did not originate from getChecklistFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteChecklists

boolean canDeleteChecklists()

Tests if this user can delete Checklists A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Checklist 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.

Returns:

false if Checklist deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteChecklist

void deleteChecklist(Id checklistId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Checklist .

Parameters:

checklistId - the Id of the Checklist to remove

Throws:

NotFoundException - checklistId not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageChecklistAliases

boolean canManageChecklistAliases()

Tests if this user can manage Id aliases for Checklists . 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.

Returns:

false if Checklist aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasChecklist

void aliasChecklist(Id checklistId,
 Id aliasId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Checklist for the purpose of creating compatibility. The primary Id of the Checklist is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another checklist, it is reassigned to the given checklist Id .

Parameters:

checklistId - the Id of a Checklist

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - checklistId not found

NullArgumentException - checklistId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.