Package org.odpi.openmetadata.frameworks.governanceaction

Interface TriageGovernanceContext

All Superinterfaces:

GovernanceContext

All Known Implementing Classes:

GovernanceActionContext

public interface 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.

Method Summary

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

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

addCatalogTarget, createGovernanceEngine, createGovernanceService, createIncidentReport, createIntegrationConnector, createIntegrationGroup, deleteGovernanceEngine, deleteGovernanceService, deleteIntegrationConnector, deleteIntegrationGroup, getActionTargetElements, getAllGovernanceEngines, getAllGovernanceServices, getAllIntegrationConnectors, getAllIntegrationGroups, getCatalogTarget, getCatalogTargets, getCompletionStatus, getEngineActionGUID, getGovernanceEngineByGUID, getGovernanceEngineByName, getGovernanceServiceByGUID, getGovernanceServiceByName, getGovernanceServiceRegistrations, getIntegrationConnectorByGUID, getIntegrationConnectorByName, getIntegrationConnectorRegistrations, getIntegrationGroupByGUID, getIntegrationGroupByName, getMaxPageSize, getOpenMetadataStore, getRegisteredGovernanceService, getRegisteredGovernanceServices, getRegisteredIntegrationConnector, getRegisteredIntegrationConnectors, getRequesterUserId, getRequestParameters, getRequestSourceElements, getRequestType, recordCompletionStatus, recordCompletionStatus, recordCompletionStatus, recordCompletionStatus, recordCompletionStatus, registerGovernanceServiceWithEngine, registerGovernanceServiceWithEngine, registerIntegrationConnectorWithGroup, removeCatalogTarget, unregisterGovernanceServiceFromEngine, unregisterIntegrationConnectorFromGroup, updateActionTargetStatus, updateCatalogTarget, updateGovernanceEngine, updateGovernanceService, updateIntegrationConnector, updateIntegrationGroup

Method Details

openToDo

String openToDo(String toDoQualifiedName,
 String title,
 String instructions,
 String toDoType,
 int priority,
 Date dueDate,
 String assignToGUID,
 String actionTargetGUID,
 String actionTargetName)
         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

toDoType - type of to do

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

dueDate - date/time this needs to be completed

assignToGUID - unique identifier for the recipient actor

actionTargetGUID - unique identifier of the element to work on.

actionTargetName - name of the element to work on.

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