Package net.solarnetwork.node.reactor

Interface InstructionStatus

All Superinterfaces:
net.solarnetwork.domain.InstructionStatus
All Known Implementing Classes:
BasicInstructionStatus
public interface InstructionStatus extends net.solarnetwork.domain.InstructionStatus
Status information for a single Instruction.
Version:
2.0
Author:
matt

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.solarnetwork.domain.InstructionStatus

    net.solarnetwork.domain.InstructionStatus.InstructionState

  • Field Summary

    Fields inherited from interface net.solarnetwork.domain.InstructionStatus

    ERROR_CODE_RESULT_PARAM, MESSAGE_RESULT_PARAM

  • Method Summary

    Modifier and Type
    Method
    Description
    net.solarnetwork.domain.InstructionStatus.InstructionState
    getAcknowledgedInstructionState()
    Get the acknowledged instruction state.
    default InstructionStatus
    newCopyWithAcknowledgedState(net.solarnetwork.domain.InstructionStatus.InstructionState newState)
    Create a new InstructionStatus copy with a new acknowledged state.
    InstructionStatus
    newCopyWithAcknowledgedState(net.solarnetwork.domain.InstructionStatus.InstructionState newState, Map<String,?> resultParameters)
    Create a new InstructionStatus copy with a new acknowledged state.
    default InstructionStatus
    newCopyWithState(net.solarnetwork.domain.InstructionStatus.InstructionState newState)
    Create a new InstructionStatus copy with a new state.
    InstructionStatus
    newCopyWithState(net.solarnetwork.domain.InstructionStatus.InstructionState newState, Map<String,?> resultParameters)
    Create a new InstructionStatus copy with a new state and result parameters.

    Methods inherited from interface net.solarnetwork.domain.InstructionStatus

    getInstructionId, getInstructionState, getResultParameters, getStatusDate

  • Method Details

    • getAcknowledgedInstructionState

      net.solarnetwork.domain.InstructionStatus.InstructionState getAcknowledgedInstructionState()
      Get the acknowledged instruction state.

      This is the state that has been posted back to SolarNet.

      Returns:
      the acknowledged instruction state, or null if never acknowledged

    • newCopyWithState

      default InstructionStatus newCopyWithState(net.solarnetwork.domain.InstructionStatus.InstructionState newState)
      Create a new InstructionStatus copy with a new state.
      Specified by:
      newCopyWithState in interface net.solarnetwork.domain.InstructionStatus
      Parameters:
      newState - the new state
      Returns:
      the new instance

    • newCopyWithState

      InstructionStatus newCopyWithState(net.solarnetwork.domain.InstructionStatus.InstructionState newState, Map<String,?> resultParameters)
      Create a new InstructionStatus copy with a new state and result parameters.
      Specified by:
      newCopyWithState in interface net.solarnetwork.domain.InstructionStatus
      Parameters:
      newState - the new state
      resultParameters - the result parameters
      Returns:
      the new instance
      Since:
      1.1

    • newCopyWithAcknowledgedState

      default InstructionStatus newCopyWithAcknowledgedState(net.solarnetwork.domain.InstructionStatus.InstructionState newState)
      Create a new InstructionStatus copy with a new acknowledged state.
      Parameters:
      newState - the new state
      Returns:
      the new instance

    • newCopyWithAcknowledgedState

      InstructionStatus newCopyWithAcknowledgedState(net.solarnetwork.domain.InstructionStatus.InstructionState newState, Map<String,?> resultParameters)
      Create a new InstructionStatus copy with a new acknowledged state.
      Parameters:
      newState - the new state
      resultParameters - the result parameters
      Returns:
      the new instance
      Since:
      1.1