Interface AssessmentOfferedBatchAdminSession
- All Superinterfaces:
AssessmentOfferedAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
This session creates, updates, and deletes AssessmentsOffered
in bulk. 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
AssessmentOffered , an AssessmentOfferedForm is requested
using getAssessmentOfferedFormsForCreate() specifying the desired
assessment and record Types or none if no record Types are
needed. Each of the returned AssessmentOfferedForms 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 an
AssessmentOfferedForm is submiited to a create operation, it cannot be
reused with another create operation unless the first operation was
unsuccessful. Each AssessmentOfferedForm corresponds to an
attempted transaction.
The AssessmentOfferedForms returned from
getAssessmentOfferedFormsForCreate() may be linked to the originating
request through the peer Ids of the AssessmentOfferedForm
. In the case where there may be duplicates, any
AssessmentOfferedForm of the same peer Ids may be used for a
create operation.
Once a batch of AssessmentOfferedForms are submitted for
create, a CreateResponse is returned for each
AssessmentOfferedForm , although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createAssessmentsOffered() , errors specific to an individual
AssessmentOfferedForm are indicated in the corresponding
CreateResponse . CreateResponses may be linked to the originating
AssessmentOfferedForm through the AssessmentOfferedForm
Id .
For updates, AssessmentOfferedForms are requested to the
AssessmentOffered Id that is to be updated using
getAssessmentOfferedFormsForUpdate() where the reference Id in
the AssessmentOfferedForm may be used to link the request.
Similarly, the AssessmentOfferedForm has metadata about the data
that can be updated and it can perform validation before submitting the
update. The AssessmentOfferedForm can only be used once for a
successful update and cannot be reused.
Once a batch of AssessmentOfferedForms are submitted for
update, an UpdateResponse is returned for each
AssessmentOfferedForm , although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateAssessmentsOffered() , errors specific to an individual
AssessmentOfferedForm are indicated in the corresponding
UpdateResponse . UpdateResponses may be linked to the originating
AssessmentOfferedForm through the AssessmentOfferedForm
Id .
The delete operations delete AssessmentsOffered in bulk. To
unmap an AssessmentOffered from the current Bank , the
AssessmentOfferedBankAssignmentSession should be used. These
delete operations attempt to remove the AssessmentOffered itself
thus removing it from all known Bank catalogs. Bulk delete
operations return the results in DeleteResponses .
-
Method Summary
Modifier and TypeMethodDescriptionaliasAssessmentsOffered(AliasRequestList aliasRequests) Adds anIdto anAssessmentOfferedfor the purpose of creating compatibility.createAssessmentsOffered(AssessmentOfferedBatchFormList assessmentOfferedForms) Creates a new set ofAssessmentsOffered.Deletes allAssessmentsOfferedin thisBank.deleteAssessmentsOffered(IdList assessmentOfferedIds) Deletes assessments offered for the givenIds.deleteAssessmentsOfferedForAssessment(Id assessmentId) Deletes all assessments offered for the given assessment,Deletes assessments offeredexpired before the given date.getAssessmentOfferedFormsForCreate(IdList assessmentIds, Type[] assessmentOfferedRecordTypes) Gets the assessment offered forms for creating a bunch of new assessments offered.getAssessmentOfferedFormsForUpdate(IdList assessmentOfferedIds) Gets the assessment offered forms for updating an existing set of assessments offered.updateAssessmentsOffered(AssessmentOfferedBatchFormList assessmentOfferedForms) Updates existing assessments offered.Methods inherited from interface AssessmentOfferedAdminSession
aliasAssessmentOffered, canCreateAssessmentOfferedWithRecordTypes, canCreateAssessmentsOffered, canDeleteAssessmentsOffered, canManageAssessmentOfferedAliases, canUpdateAssessmentsOffered, createAssessmentOffered, deleteAssessmentOffered, getAssessmentOfferedFormForCreate, getAssessmentOfferedFormForUpdate, getBank, getBankId, updateAssessmentOfferedModifier and TypeMethodDescriptionvoidaliasAssessmentOffered(Id assessmentOfferedId, Id aliasId) Adds anIdto anAssessmentOfferedfor the purpose of creating compatibility.booleancanCreateAssessmentOfferedWithRecordTypes(Type[] assessmentOfferedRecordTypes) Tests if this user can create a singleAssessmentOfferedusing the desired record types.booleanTests if this user can createAssessmentOfferedobjects.booleanTests if this user can deleteAssessmentsOffered.booleanTests if this user can manageIdaliases forAssessmentsOffered.booleanTests if this user can updateAssessmentOfferedobjects.createAssessmentOffered(AssessmentOfferedForm assessmentOfferedForm) Creates a newAssessmentOffered.voiddeleteAssessmentOffered(Id assessmentOfferedId) Deletes anAssessmentOffered.getAssessmentOfferedFormForCreate(Id assessmentId, Type[] assessmentOfferedRecordTypes) Gets the assessment offered form for creating new assessments offered.getAssessmentOfferedFormForUpdate(Id assessmentOfferedId) Gets the assessment offered form for updating an existing assessment offered.getBank()Gets theBankassociated with this session.Gets theBankIdassociated with this session.voidupdateAssessmentOffered(AssessmentOfferedForm assessmentOfferedForm) Updates an existing assessment offered.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getAssessmentOfferedFormsForCreate
AssessmentOfferedBatchFormList getAssessmentOfferedFormsForCreate(IdList assessmentIds, Type[] assessmentOfferedRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the assessment offered forms for creating a bunch of new assessments offered. An AssessmentOfferedForm is returned for each supplied assessment.- Parameters:
assessmentIds- a list of assessmentIdsassessmentOfferedRecordTypes- array of assessment offered record types to be included in each create operation or an empty list if none- Returns:
- the assessment offered forms
- Throws:
NotFoundException- anassessmentIdis not foundNullArgumentException-assessmentidsorassessmentOfferedRecordTypesisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failureUnsupportedException- unable to request forms with given record types- Compliance:
mandatory- This method must be implemented.
-
createAssessmentsOffered
CreateResponseList createAssessmentsOffered(AssessmentOfferedBatchFormList assessmentOfferedForms) throws OperationFailedException, PermissionDeniedException Creates a new set ofAssessmentsOffered. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in theBatchCreateResponse.- Parameters:
assessmentOfferedForms- the assessment offered forms- Returns:
- the create responses
- Throws:
NullArgumentException-assessmentOfferedFormsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAssessmentOfferedFormsForUpdate
AssessmentOfferedBatchFormList getAssessmentOfferedFormsForUpdate(IdList assessmentOfferedIds) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the assessment offered forms for updating an existing set of assessments offered. A new assessment offeredform should be requested for each update transaction.- Parameters:
assessmentOfferedIds- theIdsof theAssessmentOffered- Returns:
- the assessment offered form
- Throws:
NotFoundException- anassessmentOfferedIdis not foundNullArgumentException-assessmentOfferedIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
updateAssessmentsOffered
UpdateResponseList updateAssessmentsOffered(AssessmentOfferedBatchFormList assessmentOfferedForms) throws OperationFailedException, PermissionDeniedException Updates existing assessments offered. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in theBatchCreateResponse.- Parameters:
assessmentOfferedForms- the form containing the elements to be updated- Returns:
- the update responses
- Throws:
NullArgumentException-assessmentOfferedFormsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteAllAssessmentsOffered
DeleteResponseList deleteAllAssessmentsOffered() throws OperationFailedException, PermissionDeniedExceptionDeletes allAssessmentsOfferedin thisBank.- Returns:
- the delete responses
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteAssessmentsOffered
DeleteResponseList deleteAssessmentsOffered(IdList assessmentOfferedIds) throws OperationFailedException, PermissionDeniedException Deletes assessments offered for the givenIds.- Parameters:
assessmentOfferedIds- theIdsof the assessments offered to delete- Returns:
- the delete responses
- Throws:
NullArgumentException-assessmentOfferedIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteAssessmentsOfferedForAssessment
DeleteResponseList deleteAssessmentsOfferedForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException Deletes all assessments offered for the given assessment,- Parameters:
assessmentId- anIdof an assessment- Returns:
- the delete responses
- Throws:
NullArgumentException-assessmentIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteIneffectiveAssessmentsOfferedByDate
DeleteResponseList deleteIneffectiveAssessmentsOfferedByDate(DateTime date) throws OperationFailedException, PermissionDeniedException Deletes assessments offeredexpired before the given date.- Parameters:
date- a date- Returns:
- the delete responses
- Throws:
NullArgumentException-dateisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
aliasAssessmentsOffered
AliasResponseList aliasAssessmentsOffered(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException Adds anIdto anAssessmentOfferedfor the purpose of creating compatibility. The primaryIdof theAssessmentOfferedis determined by the provider. The newIdis an alias to the primaryId. If the alias is a pointer to another assessment offered, it is reassigned to the given assessment offeredId.- Parameters:
aliasRequests- the alias requests- Returns:
- the alias responses
- Throws:
NullArgumentException-aliasRequestsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-