Interface StewardshipActionInterface
- All Known Implementing Classes:
OpenMetadataClient
,OpenMetadataClientBase
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
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 TypeMethodDescriptioncreateIncidentReport
(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<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.openToDo
(String userId, String qualifiedName, String title, String instructions, String category, int priority, Date dueDate, Map<String, String> additionalProperties, String assignTo, String causeGUID, List<NewActionTarget> actionTargets) Create a "To Do" request for someone to work on.
-
Method Details
-
createIncidentReport
String createIncidentReport(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String, Integer> incidentClassifiers, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionString> additionalProperties, String originatorGUID) 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 userIdqualifiedName
- unique identifier to give this new incident reportdomainIdentifier
- governance domain associated with this action (0=ALL)background
- description of the situationimpactedResources
- details of the resources impacted by this situationpreviousIncidents
- links to previous incident reports covering this situationincidentClassifiers
- initial classifiers for the incident reportadditionalProperties
- additional arbitrary properties for the incident reportsoriginatorGUID
- 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 reportUserNotAuthorizedException
- this governance action service is not authorized to create an incident reportPropertyServerException
- there is a problem with the metadata store
-
openToDo
String openToDo(String userId, String qualifiedName, String title, String instructions, String category, int priority, Date dueDate, Map<String, String> additionalProperties, String assignTo, String causeGUID, List<NewActionTarget> actionTargets) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionCreate a "To Do" request for someone to work on.- Parameters:
userId
- caller's userIdqualifiedName
- unique name for the to do. (Could be the engine name and a guid?)title
- short meaningful phrase for the person receiving the requestinstructions
- further details on what to docategory
- 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 completedadditionalProperties
- additional arbitrary properties for the incident reportsassignTo
- qualified name of the Actor element for the recipientcauseGUID
- unique identifier of the element that describes the rule, project that this is on behalf ofactionTargets
- the list of elements that should be acted upon- Returns:
- unique identifier of new to do element
- Throws:
InvalidParameterException
- either todoQualifiedName or assignedTo are null or not recognizedUserNotAuthorizedException
- the governance action service is not authorized to create a "to do" entityPropertyServerException
- there is a problem connecting to (or inside) the metadata store
-