AccessCertificationService (midPoint API Distribution 3.4.1 API)

```
public interface AccessCertificationService
```
Interface to access certification related functionality. E.g. launching certification campaigns, filling-in certification forms, etc. EXPERIMENTAL.

Author:

mederly

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeCampaign(String campaignOid, com.evolveum.midpoint.task.api.Task task, OperationResult result)` Closes a campaign.
`void`	`closeCurrentStage(String campaignOid, int stageNumber, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Opens the next stage in the certification campaign.
`AccessCertificationCampaignType`	`createCampaign(String definitionOid, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Creates a certification campaign: creates AccessCertificationCampaignType object, based on general information in certification definition.
`AccessCertificationCasesStatisticsType`	`getCampaignStatistics(String campaignOid, boolean currentStageOnly, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Provides statistical information about outcomes of cases in a given campaign.
`void`	`openNextStage(String campaignOid, int stageNumber, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Opens the next review stage in the certification campaign.
`void`	`recordDecision(String campaignOid, long caseId, AccessCertificationDecisionType decision, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Records a particular decision of a reviewer.
`List<AccessCertificationCaseType>`	`searchDecisionsToReview(com.evolveum.midpoint.prism.query.ObjectQuery caseQuery, boolean notDecidedOnly, Collection<SelectorOptions<GetOperationOptions>> options, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)` Returns a set of certification decisions for currently logged-in user.
`void`	`startRemediation(String campaignOid, com.evolveum.midpoint.task.api.Task task, OperationResult result)` Starts the remediation phase for the campaign.

Method Detail

createCampaign

AccessCertificationCampaignType createCampaign(String definitionOid,
                                             com.evolveum.midpoint.task.api.Task task,
                                             OperationResult parentResult)
                                               throws SchemaException,
                                                      SecurityViolationException,
                                                      ConfigurationException,
                                                      ObjectNotFoundException,
                                                      CommunicationException,
                                                      ExpressionEvaluationException,
                                                      ObjectAlreadyExistsException,
                                                      PolicyViolationException

Creates a certification campaign: creates AccessCertificationCampaignType object, based on general information in certification definition. Mandatory information in the certification definition are: - definition name - definition description - handlerUri - scope definition - stage(s) definition Optional information in the certification definition: - tenant reference Owner of newly created campaign is the currently logged-on user. The campaign will NOT be started upon creation. It should be started explicitly by calling openNextStage method.

Parameters:: definitionOid - OID of certification definition for this campaign.; task - Task in context of which all operations will take place.; parentResult - Result for the operations.
Returns:: Object for the created campaign. It will be stored in the repository as well.
Throws:: SchemaException; SecurityViolationException; ConfigurationException; ObjectNotFoundException; CommunicationException; ExpressionEvaluationException; ObjectAlreadyExistsException; PolicyViolationException

openNextStage
```
void openNextStage(String campaignOid,
                 int stageNumber,
                 com.evolveum.midpoint.task.api.Task task,
                 OperationResult parentResult)
                   throws SchemaException,
                          SecurityViolationException,
                          ConfigurationException,
                          ObjectNotFoundException,
                          CommunicationException,
                          ExpressionEvaluationException,
                          ObjectAlreadyExistsException,
                          PolicyViolationException
```
Opens the next review stage in the certification campaign. If the stage being opened is the first stage, certification cases will be generated for the campaign, depending on the certification definition (scope and handler). In all stages, reviewers will be assigned to cases, based again on the definition (reviewer specification in stage definition and handler).

Parameters:
campaignOid - Certification campaign OID.
stageNumber - Stage that has to be open. This has to be the stage after the current one (or the first one).
task - Task in context of which all operations will take place.
parentResult - Result for the operations.

Throws:

SchemaException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

CommunicationException

ExpressionEvaluationException

ObjectAlreadyExistsException

PolicyViolationException

closeCurrentStage

void closeCurrentStage(String campaignOid,
                     int stageNumber,
                     com.evolveum.midpoint.task.api.Task task,
                     OperationResult parentResult)
                       throws SchemaException,
                              SecurityViolationException,
                              ConfigurationException,
                              ObjectNotFoundException,
                              CommunicationException,
                              ExpressionEvaluationException,
                              ObjectAlreadyExistsException,
                              PolicyViolationException

Opens the next stage in the certification campaign. If the stage being opened is the first stage, certification cases will be generated for the campaign, depending on the certification definition (scope and handler). In all stages, reviewers will be assigned to cases, based again on the definition (reviewer specification in stage definition and handler).

Parameters:: campaignOid - Certification campaign OID.; stageNumber - Stage that has to be closed. This has to be the current stage.; task - Task in context of which all operations will take place.; parentResult - Result for the operations.
Throws:: SchemaException; SecurityViolationException; ConfigurationException; ObjectNotFoundException; CommunicationException; ExpressionEvaluationException; ObjectAlreadyExistsException; PolicyViolationException

startRemediation

void startRemediation(String campaignOid,
                    com.evolveum.midpoint.task.api.Task task,
                    OperationResult result)
                      throws ObjectNotFoundException,
                             SchemaException,
                             CommunicationException,
                             ConfigurationException,
                             SecurityViolationException,
                             ObjectAlreadyExistsException

Starts the remediation phase for the campaign. The campaign has to be in the last stage and that stage has to be already closed.

Parameters:: campaignOid -; task -; result -
Throws:: ObjectNotFoundException; SchemaException; CommunicationException; ConfigurationException; SecurityViolationException; ObjectAlreadyExistsException

closeCampaign

void closeCampaign(String campaignOid,
                 com.evolveum.midpoint.task.api.Task task,
                 OperationResult result)
                   throws ObjectNotFoundException,
                          SchemaException,
                          CommunicationException,
                          ConfigurationException,
                          SecurityViolationException,
                          ObjectAlreadyExistsException

Closes a campaign.

Parameters:: campaignOid -; task -; result -
Throws:: ObjectNotFoundException; SchemaException; CommunicationException; ConfigurationException; SecurityViolationException; ObjectAlreadyExistsException

searchDecisionsToReview
```
List<AccessCertificationCaseType> searchDecisionsToReview(com.evolveum.midpoint.prism.query.ObjectQuery caseQuery,
                                                        boolean notDecidedOnly,
                                                        Collection<SelectorOptions<GetOperationOptions>> options,
                                                        com.evolveum.midpoint.task.api.Task task,
                                                        OperationResult parentResult)
                                                          throws ObjectNotFoundException,
                                                                 SchemaException,
                                                                 SecurityViolationException,
                                                                 ConfigurationException,
                                                                 CommunicationException
```
Returns a set of certification decisions for currently logged-in user. Each decision is returned in context of its certification case. Case has to match a given query. So, in contrast to model.searchContainers(AccessCertificationCaseType...) method that returns specified cases with all their decisions, this one returns a list of cases where each case has at most one decision: the one that corresponds to specified reviewer and current certification stage. Zero decisions means that the reviewer has not provided any decision yet. Query argument for cases is the same as in the model.searchContainers(AccessCertificationCaseType...) call.

Parameters:
caseQuery - Specification of the cases to retrieve.
notDecidedOnly - If true, only response==(NO_DECISION or null) should be returned. Although it can be formulated in Query API terms, this would refer to implementation details - so the cleaner way is keep this knowledge inside certification module only.
options - Options to use (e.g. RESOLVE_NAMES).
task - Task in context of which all operations will take place.
parentResult - Result for the operations.

Returns:
A list of relevant certification cases.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

CommunicationException

recordDecision

void recordDecision(String campaignOid,
                  long caseId,
                  AccessCertificationDecisionType decision,
                  com.evolveum.midpoint.task.api.Task task,
                  OperationResult parentResult)
                    throws ObjectNotFoundException,
                           SchemaException,
                           SecurityViolationException,
                           ConfigurationException,
                           CommunicationException,
                           ObjectAlreadyExistsException

Records a particular decision of a reviewer.

Parameters:: campaignOid - OID of the campaign to which the decision belongs.; caseId - ID of the certification case to which the decision belongs.; decision - The decision itself.; task - Task in context of which all operations will take place.; parentResult - Result for the operations.
Throws:: ObjectNotFoundException; SchemaException; SecurityViolationException; ConfigurationException; CommunicationException; ObjectAlreadyExistsException

getCampaignStatistics

AccessCertificationCasesStatisticsType getCampaignStatistics(String campaignOid,
                                                           boolean currentStageOnly,
                                                           com.evolveum.midpoint.task.api.Task task,
                                                           OperationResult parentResult)
                                                             throws ObjectNotFoundException,
                                                                    SchemaException,
                                                                    SecurityViolationException,
                                                                    ConfigurationException,
                                                                    CommunicationException,
                                                                    ObjectAlreadyExistsException

Provides statistical information about outcomes of cases in a given campaign.

Parameters:: campaignOid - OID of the campaign to report on; currentStageOnly - Whether to report on stage outcomes for current-stage cases (if true), or to report on overall outcomes of all cases (if false).; task - Task in context of which all operations will take place.; parentResult - Result for the operations.
Returns:: filled-in statistics object
Throws:: ObjectNotFoundException; SchemaException; SecurityViolationException; ConfigurationException; CommunicationException; ObjectAlreadyExistsException

Interface AccessCertificationService