Package org.odpi.openmetadata.commonservices.gaf.api

Interface StewardshipActionInterface

All Known Implementing Classes:

GovernanceEngineClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClientBase

public interface StewardshipActionInterface

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	createIncidentReport(java.lang.String userId, java.lang.String qualifiedName, int domainIdentifier, java.lang.String background, java.util.List<IncidentImpactedElement> impactedResources, java.util.List<IncidentDependency> previousIncidents, java.util.Map<java.lang.String,java.lang.Integer> incidentClassifiers, java.util.Map<java.lang.String,java.lang.String> additionalProperties, java.lang.String originatorGUID)	Create an incident report to capture the situation detected by this governance action service.
java.lang.String	openToDo(java.lang.String userId, java.lang.String toDoQualifiedName, java.lang.String title, java.lang.String instructions, int priority, java.util.Date dueDate, java.lang.String assignTo)	Create a "To Do" request for someone to work on.

Method Detail

createIncidentReport

java.lang.String createIncidentReport(java.lang.String userId,
                                      java.lang.String qualifiedName,
                                      int domainIdentifier,
                                      java.lang.String background,
                                      java.util.List<IncidentImpactedElement> impactedResources,
                                      java.util.List<IncidentDependency> previousIncidents,
                                      java.util.Map<java.lang.String,java.lang.Integer> incidentClassifiers,
                                      java.util.Map<java.lang.String,java.lang.String> additionalProperties,
                                      java.lang.String originatorGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      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:

userId - caller's userId

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:

InvalidParameterException - null or non-unique qualified name for the incident report

UserNotAuthorizedException - this governance action service is not authorized to create an incident report

PropertyServerException - there is a problem with the metadata store

openToDo

java.lang.String openToDo(java.lang.String userId,
                          java.lang.String toDoQualifiedName,
                          java.lang.String title,
                          java.lang.String instructions,
                          int priority,
                          java.util.Date dueDate,
                          java.lang.String assignTo)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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

Parameters:

userId - caller's userId

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