org.odpi.openmetadata.frameworks.governanceaction

Class TriageGovernanceContext

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.GovernanceContext

org.odpi.openmetadata.frameworks.governanceaction.TriageGovernanceContext

public class TriageGovernanceContext
extends GovernanceContext

TriageGovernanceContext provides access to details of the triage request and associated governance action plus with access to the metadata store. A triage governance action service typically assesses the request source elements and makes a choice to call an external triage service, create a to-do for a profile in the open metadata ecosystem, or directly completing the associated governance action with a decision for the completion status and guards that are used to determine the next step to proceed.

Constructor Summary

Constructors

Constructor and Description
TriageGovernanceContext(String userId, String governanceActionGUID, String requestType, Map<String,String> requestParameters, List<RequestSourceElement> requestSourceElements, List<ActionTargetElement> actionTargetElements, OpenMetadataClient openMetadataStore) Constructor sets up the key parameters for processing the request to the governance action service.

Method Summary

Modifier and Type	Method and Description
String	openToDo(String toDoQualifiedName, String title, String instructions, int priority, Date dueDate, String assignTo) Create a To Do request for someone to work on.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceContext

getActionTargetElements, getCompletionStatus, getOpenMetadataStore, getRequestParameters, getRequestSourceElements, getRequestType, recordCompletionStatus, recordCompletionStatus, recordCompletionStatus, toString, updateActionTargetStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TriageGovernanceContext

public TriageGovernanceContext(String userId,
                               String governanceActionGUID,
                               String requestType,
                               Map<String,String> requestParameters,
                               List<RequestSourceElement> requestSourceElements,
                               List<ActionTargetElement> actionTargetElements,
                               OpenMetadataClient openMetadataStore)

Constructor sets up the key parameters for processing the request to the governance action service.

Parameters:

userId - calling user

governanceActionGUID - unique identifier of the governance action that triggered this governance service

requestType - unique identifier of the asset that the annotations should be attached to

requestParameters - name-value properties to control the governance action service

requestSourceElements - metadata elements associated with the request to the governance action service

actionTargetElements - metadata elements that need to be worked on by the governance action service

openMetadataStore - client to the metadata store for use by the governance action service

Method Detail

openToDo

public String openToDo(String toDoQualifiedName,
                       String title,
                       String instructions,
                       int priority,
                       Date dueDate,
                       String assignTo)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Create a To Do request for someone to work on.

Parameters:

toDoQualifiedName - unique name for the to do. (Could be the engine name and a guid?)

title - short meaningful phrase for the person receiving the request

instructions - further details on what to do

priority - priority value (based on organization's scale)

dueDate - date/time this needs to be completed

assignTo - qualified name of the PersonRole element for the recipient

Returns:

unique identifier of new to do element

Throws:

InvalidParameterException - either todoQualifiedName or assignedTo are null or not recognized

UserNotAuthorizedException - the governance action service is not authorized to create a to do

PropertyServerException - there is a problem connecting to (or inside) the metadata store