org.osid.inquiry

Interface InquestAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

InquestBatchAdminSession

public interface InquestAdminSession
extends OsidSession

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

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

The delete operations delete Inquests.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasInquest(Id inquestId, Id aliasId) Adds an Id to an Inquest for the purpose of creating compatibility.
boolean	canCreateInquests() Tests if this user can create Inquests.
boolean	canCreateInquestWithRecordTypes(Type[] inquestRecordTypes) Tests if this user can create a single Inquest using the desired record types.
boolean	canDeleteInquests() Tests if this user can delete Inquests.
boolean	canManageInquestAliases() Tests if this user can manage Id aliases for Inquests.
boolean	canUpdateInquests() Tests if this user can update Inquests.
Inquest	createInquest(InquestForm inquestForm) Creates a new Inquest.
void	deleteInquest(Id inquestId) Deletes an Inquest.
InquestForm	getInquestFormForCreate(Type[] inquestRecordTypes) Gets the inquest form for creating new inquests.
InquestForm	getInquestFormForUpdate(Id inquestId) Gets the inquest form for updating an existing inquest.
void	updateInquest(InquestForm inquestForm) Updates an existing inquest

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canCreateInquests

boolean canCreateInquests()

Tests if this user can create Inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Inquest. 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 Inquest creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateInquestWithRecordTypes

boolean canCreateInquestWithRecordTypes(Type[] inquestRecordTypes)

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

Parameters:

inquestRecordTypes - array of inquest record types

Returns:

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

Throws:

NullArgumentException - inquestRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getInquestFormForCreate

InquestForm getInquestFormForCreate(Type[] inquestRecordTypes)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the inquest form for creating new inquests. A new form should be requested for each create transaction.

Parameters:

inquestRecordTypes - array of inquest record types

Returns:

the inquest form

Throws:

NullArgumentException - inquestRecordTypes 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.

createInquest

Inquest createInquest(InquestForm inquestForm)
                      throws OperationFailedException,
                             PermissionDeniedException

Creates a new Inquest.

Parameters:

inquestForm - the form for this Inquest

Returns:

the new Inquest

Throws:

IllegalStateException - inquestForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - inquestForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquestForm did not originate from getInquestFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateInquests

boolean canUpdateInquests()

Tests if this user can update Inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Inquest 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 Inquest modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getInquestFormForUpdate

InquestForm getInquestFormForUpdate(Id inquestId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

the inquest form

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateInquest

void updateInquest(InquestForm inquestForm)
                   throws OperationFailedException,
                          PermissionDeniedException

Updates an existing inquest

Parameters:

inquestForm - the form containing the elements to be updated

Throws:

IllegalStateException - inquestForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - inquestForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquestForm did not originate from getInquestFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteInquests

boolean canDeleteInquests()

Tests if this user can delete Inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Inquest 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 Inquest deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteInquest

void deleteInquest(Id inquestId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Deletes an Inquest.

Parameters:

inquestId - the Id of the Inquest to remove

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageInquestAliases

boolean canManageInquestAliases()

Tests if this user can manage Id aliases for Inquests. 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 Inquest aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasInquest

void aliasInquest(Id inquestId,
                Id aliasId)
                  throws AlreadyExistsException,
                         NotFoundException,
                         OperationFailedException,
                         PermissionDeniedException

Adds an Id to an Inquest for the purpose of creating compatibility. The primary Id of the Inquest is determined by the provider. The new Id performs as an alias to the primary Id.

Parameters:

inquestId - the Id of an Inquest

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - inquestId not found

NullArgumentException - inquestId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.