Package org.odpi.openmetadata.frameworks.integration.context

Class StewardshipAction

java.lang.Object

org.odpi.openmetadata.frameworks.integration.context.StewardshipAction

public class StewardshipAction
extends Object

StewardshipAction defines methods that are used to request help for a situation that the caller can not handle.

Constructor Summary

Constructors

Constructor	Description
StewardshipAction(org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient openMetadataStore, String userId)	The constructor needs an implementation of the open metadata store.

Method Summary

Modifier and Type	Method	Description
String	createIncidentReport(String qualifiedName, int domainIdentifier, String background, List<org.odpi.openmetadata.frameworks.governanceaction.properties.IncidentImpactedElement> impactedResources, List<org.odpi.openmetadata.frameworks.governanceaction.properties.IncidentDependency> previousIncidents, Map<String,Integer> incidentClassifiers, Map<String,String> additionalProperties, String originatorGUID)	Create an incident report to capture the situation detected by this governance action service.
String	openToDo(String qualifiedName, String title, String instructions, String category, int priority, Date dueDate, Map<String,String> additionalProperties, String assignTo, String causeGUID, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets)	Create a "To Do" request for someone to work on.

Methods inherited from class java.lang.Object

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

Constructor Details

StewardshipAction

public StewardshipAction(org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient openMetadataStore,
 String userId)

The constructor needs an implementation of the open metadata store.

Parameters:

openMetadataStore - client implementation

userId - calling user

Method Details

createIncidentReport

public String createIncidentReport(String qualifiedName,
 int domainIdentifier,
 String background,
 List<org.odpi.openmetadata.frameworks.governanceaction.properties.IncidentImpactedElement> impactedResources,
 List<org.odpi.openmetadata.frameworks.governanceaction.properties.IncidentDependency> previousIncidents,
 Map<String,Integer> incidentClassifiers,
 Map<String,String> additionalProperties,
 String originatorGUID)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.

Parameters:

qualifiedName - unique identifier to give this new incident report

domainIdentifier - governance domain associated with this action (0=ALL)

background - description of the situation

impactedResources - details of the resources impacted by this situation

previousIncidents - links to previous incident reports covering this situation

incidentClassifiers - initial classifiers for the incident report

additionalProperties - additional arbitrary properties for the incident reports

originatorGUID - the unique identifier of the person or process that created the incident

Returns:

unique identifier of the resulting incident report

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null or non-unique qualified name for the incident report

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this governance action service is not authorized to create an incident report

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

openToDo

public String openToDo(String qualifiedName,
 String title,
 String instructions,
 String category,
 int priority,
 Date dueDate,
 Map<String,String> additionalProperties,
 String assignTo,
 String causeGUID,
 List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets)
                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a "To Do" request for someone to work on.

Parameters:

qualifiedName - 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

category - a category of to dos (for example, "data error", "access request")

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

dueDate - date/time this needs to be completed

additionalProperties - additional arbitrary properties for the incident reports

assignTo - qualified name of the Actor element for the recipient

causeGUID - unique identifier of the element that describes the rule, project that this is on behalf of

actionTargets - the list of elements that should be acted upon

Returns:

unique identifier of new to do element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either todoQualifiedName or assignedTo are null or not recognized

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to create a "to do" entity

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem connecting to (or inside) the metadata store