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

Interface StewardshipActionInterface

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

    • Method Detail

      • createIncidentReport

        String createIncidentReport​(String userId,
                            String qualifiedName,
                            int domainIdentifier,
                            String background,
                            List<IncidentImpactedElement> impactedResources,
                            List<IncidentDependency> previousIncidents,
                            Map<String,​Integer> incidentClassifiers,
                            Map<String,​String> additionalProperties,
                            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

        String openToDo​(String userId,
                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:
        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