Class LogbookOperationParameters

    • Constructor Detail

      • LogbookOperationParameters

        protected LogbookOperationParameters​(java.util.Map<java.lang.String,​java.lang.String> map)
        Builder for REST interface
        Parameters:
        map -
        Throws:
        java.lang.IllegalArgumentException - if one key is not allowed
    • Method Detail

      • toString

        public java.lang.String toString()
      • setEvents

        public void setEvents​(java.util.Set<LogbookParameters> events)
        Set event list
        Parameters:
        events - the list of events
      • getEvents

        public java.util.Set<LogbookParameters> getEvents()
        Get event list
        Returns:
        the event list
      • getEventDateTime

        public java.time.LocalDateTime getEventDateTime()
        Description copied from interface: LogbookParameters
        The EventDateTime is set by the Logbook methods during creation or append
        Specified by:
        getEventDateTime in interface LogbookParameters
        Returns:
        the associated EventDateTime if set (or null if not set yet)
      • setFinalStatus

        public LogbookParameters setFinalStatus​(java.lang.String handlerId,
                                                java.lang.String subTaskId,
                                                StatusCode code,
                                                java.lang.String additionalMessage,
                                                java.lang.String... params)
        Description copied from interface: LogbookParameters
        Update the current LogbookParameters with status and message
        Specified by:
        setFinalStatus in interface LogbookParameters
        Parameters:
        handlerId - the Handler Id
        subTaskId - the subTask Id if any (may be null)
        code - the Status CodeAdminManagementClientRestTest
        additionalMessage - the additional message (as " Details= ...") if any (may be null)
        params - the additional parameters for the message if any (may be null)
        Returns:
        this
      • setBeginningLog

        public LogbookParameters setBeginningLog​(java.lang.String handlerId,
                                                 java.lang.String subTaskId,
                                                 java.lang.String additionnalMessage,
                                                 java.lang.String... params)
        Description copied from interface: LogbookParameters
        Update the current LogbookParameters with status and message
        Specified by:
        setBeginningLog in interface LogbookParameters
        Parameters:
        handlerId - the Handler Id
        subTaskId - the subTask Id if any (may be null)
        additionnalMessage - the additional message (as " Details= ...") if any (may be null)
        params - the additional parameters for the message if any (may be null)
        Returns:
        this
      • putParameterValue

        public LogbookParameters putParameterValue​(LogbookParameterName parameterName,
                                                   java.lang.String parameterValue)
        Description copied from interface: LogbookParameters
        Put parameterValue on mapParamaters with parameterName key

        If parameterKey already exists, the override it (no check)
        Specified by:
        putParameterValue in interface LogbookParameters
        Parameters:
        parameterName - the key of the parameter to put on the parameter map
        parameterValue - the value to put on the parameter map
        Returns:
        actual instance of LogbookParameters (fluent like)