Class GovernanceActionProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class GovernanceActionProperties
    extends ReferenceableProperties
    GovernanceActionProperties provides a structure for carrying the properties for a governance action.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      GovernanceActionStatus getActionStatus()
      Return the current status of the governance action.
      java.util.List<ActionTargetElement> getActionTargetElements()
      Return the list of elements that the governance action will work on.
      java.util.List<java.lang.String> getCompletionGuards()
      Return the list of completion guards supplied by the governance service.
      java.util.Date getCompletionTime()
      Return the date/time that the governance service completed (or null if not yet completed).
      java.lang.String getDescription()
      Return the description of the governance action.
      java.lang.String getDisplayName()
      Return the display name for the governance action.
      int getDomainIdentifier()
      Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
      java.lang.String getGovernanceActionTypeGUID()
      Return the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
      java.lang.String getGovernanceActionTypeName()
      Return the unique name for the governance action type that acted as a template for this governance action (if appropriate).
      java.lang.String getGovernanceEngineGUID()
      Return the unique identifier of governance engine that is processing the governance action.
      java.lang.String getGovernanceEngineName()
      Return the unique name of governance engine that is processing the governance action.
      java.util.List<java.lang.String> getMandatoryGuards()
      Return the list of guards that must be received before this governance action can proceed.
      java.lang.String getProcessingEngineUserId()
      Return the userId of the governance engine that is responsible for running the governance service for this governance action.
      java.lang.String getProcessName()
      Return the name of the governance action process - or similar request source.
      java.util.List<java.lang.String> getReceivedGuards()
      Return the list of guards provided by the previous governance service(s).
      java.util.Date getRequestedTime()
      Return the time that the governance action was created.
      java.util.Map<java.lang.String,​java.lang.String> getRequestParameters()
      Return the parameters to pass onto the governance service.
      java.util.List<RequestSourceElement> getRequestSourceElements()
      Return the list of elements that triggered this request.
      java.lang.String getRequestType()
      Return the request type associated with this governance action.
      java.util.Date getStartTime()
      Return the time that this governance action should start (null means as soon as possible).
      int hashCode()
      Return hash code for this object
      void setActionStatus​(GovernanceActionStatus actionStatus)
      Set up the current status of the governance action.
      void setActionTargetElements​(java.util.List<ActionTargetElement> actionTargetElements)
      Set up the list of elements that the governance action will work on.
      void setCompletionGuards​(java.util.List<java.lang.String> completionGuards)
      Set up the list of completion guards supplied by the governance service.
      void setCompletionTime​(java.util.Date completionTime)
      Set up the date/time that the governance service completed (or null if not yet completed).
      void setDescription​(java.lang.String description)
      Set up the description of the governance action.
      void setDisplayName​(java.lang.String displayName)
      Set up the display name for the governance action.
      void setDomainIdentifier​(int domainIdentifier)
      Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
      void setGovernanceActionTypeGUID​(java.lang.String governanceActionTypeGUID)
      Set up the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
      void setGovernanceActionTypeName​(java.lang.String governanceActionTypeName)
      Set up the unique name for the governance action type that acted as a template for this governance action (if appropriate).
      void setGovernanceEngineGUID​(java.lang.String governanceEngineGUID)
      Set up the unique identifier of governance engine that is processing the governance action.
      void setGovernanceEngineName​(java.lang.String governanceEngineName)
      Set up the unique name of governance engine that is processing the governance action.
      void setMandatoryGuards​(java.util.List<java.lang.String> mandatoryGuards)
      Set up the list of guards that must be received before this governance action can proceed.
      void setProcessingEngineUserId​(java.lang.String processingEngineUserId)
      Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
      void setProcessName​(java.lang.String processName)
      Set up the name of the governance action process - or similar request source.
      void setReceivedGuards​(java.util.List<java.lang.String> receivedGuards)
      Set up the list of guards provided by the previous governance service(s).
      void setRequestedTime​(java.util.Date requestedTime)
      Set up the time that the governance action was created.
      void setRequestParameters​(java.util.Map<java.lang.String,​java.lang.String> requestParameters)
      Set up the parameters to pass onto the governance service.
      void setRequestSourceElements​(java.util.List<RequestSourceElement> requestSourceElements)
      Set up the list of elements that triggered this request.
      void setRequestType​(java.lang.String requestType)
      Set up the request type associated with this governance action, used to identify ths governance service to run.
      void setStartTime​(java.util.Date startTime)
      Set up the time that this governance action should start (null means as soon as possible).
      java.lang.String toString()
      JSON-style toString.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • 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 java.lang.String getDisplayName()
        Return the display name for the governance action.
        Returns:
        string name
      • setDisplayName

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

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

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

        public java.util.List<java.lang.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​(java.util.List<java.lang.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 java.util.List<java.lang.String> getReceivedGuards()
        Return the list of guards provided by the previous governance service(s).
        Returns:
        list of guards
      • setReceivedGuards

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

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

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

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

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

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

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

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.util.List<RequestSourceElement> getRequestSourceElements()
        Return the list of elements that triggered this request.
        Returns:
        list of elements
      • setRequestSourceElements

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

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

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

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

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

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

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

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

        public void setRequestType​(java.lang.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 java.util.Map<java.lang.String,​java.lang.String> getRequestParameters()
        Return the parameters to pass onto the governance service.
        Returns:
        map of properties
      • setRequestParameters

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

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

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

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

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

        public java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        list of properties and their values.
      • equals

        public boolean equals​(java.lang.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