Package org.odpi.openmetadata.accessservices.governanceengine.properties

Class GovernanceActionProperties

    • Constructor Detail

      • GovernanceActionProperties

        public GovernanceActionProperties()
        Default constructor

      • GovernanceActionProperties

        public GovernanceActionProperties​(GovernanceActionProperties template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • getDomainIdentifier

        public int getDomainIdentifier()
        Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
        Returns:
        int

      • setDomainIdentifier

        public void setDomainIdentifier​(int domainIdentifier)
        Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
        Parameters:
        domainIdentifier - int

      • getDisplayName

        public String getDisplayName()
        Return the display name for the governance action.
        Returns:
        string name

      • setDisplayName

        public void setDisplayName​(String displayName)
        Set up the display name for the governance action.
        Parameters:
        displayName - string name

      • getDescription

        public String getDescription()
        Return the description of the governance action.
        Returns:
        string text

      • setDescription

        public void setDescription​(String description)
        Set up the description of the governance action.
        Parameters:
        description - string text

      • getMandatoryGuards

        public List<String> getMandatoryGuards()
        Return the list of guards that must be received before this governance action can proceed.
        Returns:
        list of guards

      • setMandatoryGuards

        public void setMandatoryGuards​(List<String> mandatoryGuards)
        Set up the list of guards that must be received before this governance action can proceed.
        Parameters:
        mandatoryGuards - list of guards

      • getReceivedGuards

        public List<String> getReceivedGuards()
        Return the list of guards provided by the previous governance service(s).
        Returns:
        list of guards

      • setReceivedGuards

        public void setReceivedGuards​(List<String> receivedGuards)
        Set up the list of guards provided by the previous governance service(s).
        Parameters:
        receivedGuards - list of guards

      • getGovernanceEngineGUID

        public String getGovernanceEngineGUID()
        Return the unique identifier of governance engine that is processing the governance action.
        Returns:
        string guid

      • setGovernanceEngineGUID

        public void setGovernanceEngineGUID​(String governanceEngineGUID)
        Set up the unique identifier of governance engine that is processing the governance action.
        Parameters:
        governanceEngineGUID - string guid

      • getGovernanceEngineName

        public String getGovernanceEngineName()
        Return the unique name of governance engine that is processing the governance action.
        Returns:
        string name

      • setGovernanceEngineName

        public void setGovernanceEngineName​(String governanceEngineName)
        Set up the unique name of governance engine that is processing the governance action.
        Parameters:
        governanceEngineName - string name

      • getProcessName

        public String getProcessName()
        Return the name of the governance action process - or similar request source.
        Returns:
        name

      • setProcessName

        public void setProcessName​(String processName)
        Set up the name of the governance action process - or similar request source.
        Parameters:
        processName - name

      • getGovernanceActionTypeGUID

        public String getGovernanceActionTypeGUID()
        Return the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
        Returns:
        guid

      • setGovernanceActionTypeGUID

        public void setGovernanceActionTypeGUID​(String governanceActionTypeGUID)
        Set up the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
        Parameters:
        governanceActionTypeGUID - guid

      • getGovernanceActionTypeName

        public String getGovernanceActionTypeName()
        Return the unique name for the governance action type that acted as a template for this governance action (if appropriate).
        Returns:
        name

      • setGovernanceActionTypeName

        public void setGovernanceActionTypeName​(String governanceActionTypeName)
        Set up the unique name for the governance action type that acted as a template for this governance action (if appropriate).
        Parameters:
        governanceActionTypeName - name

      • getActionStatus

        public GovernanceActionStatus getActionStatus()
        Return the current status of the governance action.
        Returns:
        status enum

      • setActionStatus

        public void setActionStatus​(GovernanceActionStatus actionStatus)
        Set up the current status of the governance action.
        Parameters:
        actionStatus - status enum

      • getProcessingEngineUserId

        public String getProcessingEngineUserId()
        Return the userId of the governance engine that is responsible for running the governance service for this governance action.
        Returns:
        string userId

      • setProcessingEngineUserId

        public void setProcessingEngineUserId​(String processingEngineUserId)
        Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
        Parameters:
        processingEngineUserId - string userId

      • getRequestSourceElements

        public List<RequestSourceElement> getRequestSourceElements()
        Return the list of elements that triggered this request.
        Returns:
        list of elements

      • setRequestSourceElements

        public void setRequestSourceElements​(List<RequestSourceElement> requestSourceElements)
        Set up the list of elements that triggered this request.
        Parameters:
        requestSourceElements - list of elements

      • getActionTargetElements

        public List<ActionTargetElement> getActionTargetElements()
        Return the list of elements that the governance action will work on.
        Returns:
        list of elements

      • setActionTargetElements

        public void setActionTargetElements​(List<ActionTargetElement> actionTargetElements)
        Set up the list of elements that the governance action will work on.
        Parameters:
        actionTargetElements - list of elements

      • getRequestedTime

        public Date getRequestedTime()
        Return the time that the governance action was created.
        Returns:
        date/time

      • setRequestedTime

        public void setRequestedTime​(Date requestedTime)
        Set up the time that the governance action was created.
        Parameters:
        requestedTime - date/time

      • getStartTime

        public Date getStartTime()
        Return the time that this governance action should start (null means as soon as possible).
        Returns:
        date object

      • setStartTime

        public void setStartTime​(Date startTime)
        Set up the time that this governance action should start (null means as soon as possible).
        Parameters:
        startTime - date object

      • getRequestType

        public String getRequestType()
        Return the request type associated with this governance action.
        Returns:
        string name

      • setRequestType

        public void setRequestType​(String requestType)
        Set up the request type associated with this governance action, used to identify ths governance service to run.
        Parameters:
        requestType - string name

      • getRequestParameters

        public Map<String,​String> getRequestParameters()
        Return the parameters to pass onto the governance service.
        Returns:
        map of properties

      • setRequestParameters

        public void setRequestParameters​(Map<String,​String> requestParameters)
        Set up the parameters to pass onto the governance service.
        Parameters:
        requestParameters - map of properties

      • getCompletionTime

        public Date getCompletionTime()
        Return the date/time that the governance service completed (or null if not yet completed).
        Returns:
        date object

      • setCompletionTime

        public void setCompletionTime​(Date completionTime)
        Set up the date/time that the governance service completed (or null if not yet completed).
        Parameters:
        completionTime - date object

      • getCompletionGuards

        public List<String> getCompletionGuards()
        Return the list of completion guards supplied by the governance service.
        Returns:
        list of guards

      • setCompletionGuards

        public void setCompletionGuards​(List<String> completionGuards)
        Set up the list of completion guards supplied by the governance service.
        Parameters:
        completionGuards - list of guards

      • equals

        public boolean equals​(Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class ReferenceableProperties
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison