Package fr.gouv.vitam.common.i18n

Class VitamLogbookMessages

  • public class VitamLogbookMessages
extends java.lang.Object
    Vitam Messages Helper for Logbooks

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean containsKey​(java.lang.String key)  
      static java.util.Map<java.lang.String,​java.lang.String> getAllMessages()
      Retrieve all the messages
      static java.lang.String getCodeLfc​(java.lang.String stepOrHandler, StatusCode code)
      Lifecycle Logbook context
      static java.lang.String getCodeLfc​(java.lang.String stepOrHandler, StatusCode code, java.lang.Object... args)
      Lifecycle Logbook context
      static java.lang.String getCodeLfc​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code)
      Lifecycle Logbook context
      static java.lang.String getCodeLfc​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code, java.lang.Object... args)
      Lifecycle Logbook context
      static java.lang.String getCodeLfc​(java.lang.String stepOrHandler, java.lang.String transaction, java.lang.String detailedOutcome, StatusCode code, java.lang.Object... args)
      Lifecycle Logbook context
      static java.lang.String getCodeOp​(java.lang.String stepOrHandler, StatusCode code)
      Operation Logbook context
      static java.lang.String getCodeOp​(java.lang.String stepOrHandler, StatusCode code, java.lang.Object... args)
      Operation Logbook context
      static java.lang.String getCodeOp​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code)
      Operation Logbook context
      static java.lang.String getCodeOp​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code, java.lang.Object... args)
      Operation Logbook context
      static java.lang.String getEventTypeLfc​(java.lang.String stepOrHandler)  
      static java.lang.String getEventTypeStarted​(java.lang.String stepOrHandler)  
      static java.lang.String getFromFullCodeKey​(java.lang.String completeCodeKey)
      Get a message labe knowing its full code key
      static java.lang.String getFromFullCodeKey​(java.lang.String completeCodeKey, java.lang.Object... args)  
      static java.lang.String getLabelLfc​(java.lang.String stepOrHandler)
      Lifecycle Logbook context
      static java.lang.String getLabelLfc​(java.lang.String stepOrHandler, java.lang.String transaction)
      Lifecycle Logbook context
      static java.lang.String getLabelOp​(java.lang.String stepOrHandler)
      Operation Logbook context
      static java.lang.String getLabelOp​(java.lang.String stepOrHandler, java.lang.String transaction)
      Operation Logbook context
      static java.lang.String getOutcomeDetail​(java.lang.String stepOrHandler, StatusCode code)  
      static java.lang.String getOutcomeDetail​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code)  
      static java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler, StatusCode code)  
      static java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler, java.lang.String transaction, StatusCode code)  
      static java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler, java.lang.String transaction, java.lang.String detailedOutcome, StatusCode code)  
      static java.lang.String getSeparator()  
      static java.lang.String getSubTaskEventTypeLfc​(java.lang.String stepOrHandler, java.lang.String subTaskName)  
      static java.lang.String getSubTaskEventTypeOp​(java.lang.String stepOrHandler, java.lang.String subTaskName)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getAllMessages

        public static java.util.Map<java.lang.String,​java.lang.String> getAllMessages()
        Retrieve all the messages
        Returns:
        map of messages

      • getLabelOp

        public static final java.lang.String getLabelOp​(java.lang.String stepOrHandler)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        Returns:
        the Label of this step or handler or full named

      • getLabelLfc

        public static final java.lang.String getLabelLfc​(java.lang.String stepOrHandler)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        Returns:
        the Label of this step or handler or full named

      • getEventTypeStarted

        public static final java.lang.String getEventTypeStarted​(java.lang.String stepOrHandler)
        Parameters:
        stepOrHandler - step or handler name or full name
        Returns:
        the final EventType code

      • getEventTypeLfc

        public static final java.lang.String getEventTypeLfc​(java.lang.String stepOrHandler)
        Parameters:
        stepOrHandler - step or handler name or full name
        Returns:
        the final EventType code

      • getSubTaskEventTypeLfc

        public static final java.lang.String getSubTaskEventTypeLfc​(java.lang.String stepOrHandler,
                                                            java.lang.String subTaskName)
        Parameters:
        stepOrHandler - step or handler name or full name
        subTaskName - name of the sub task
        Returns:
        the final EventType code

      • getSubTaskEventTypeOp

        public static final java.lang.String getSubTaskEventTypeOp​(java.lang.String stepOrHandler,
                                                           java.lang.String subTaskName)
        Parameters:
        stepOrHandler - step or handler name or full name
        subTaskName - name of the sub task
        Returns:
        the final EventType code

      • getLabelOp

        public static final java.lang.String getLabelOp​(java.lang.String stepOrHandler,
                                                java.lang.String transaction)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        Returns:
        the Label of this step or handler or full named with sub transaction

      • getLabelLfc

        public static final java.lang.String getLabelLfc​(java.lang.String stepOrHandler,
                                                 java.lang.String transaction)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        Returns:
        the Label of this step or handler or full named with sub transaction

      • getOutcomeDetail

        public static final java.lang.String getOutcomeDetail​(java.lang.String stepOrHandler,
                                                      StatusCode code)
        Parameters:
        stepOrHandler - step or handler name or full name
        code - the code from which the message is needed
        Returns:
        the code to place within outcomeDetail (Logbooks)

      • getOutcomeDetailLfc

        public static final java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler,
                                                         StatusCode code)
        Parameters:
        stepOrHandler - step or handler name or full name
        code - of status
        Returns:
        the code to place within outcomeDetail (Logbooks)

      • getOutcomeDetail

        public static final java.lang.String getOutcomeDetail​(java.lang.String stepOrHandler,
                                                      java.lang.String transaction,
                                                      StatusCode code)
        Parameters:
        stepOrHandler - step or handler name or full name
        transaction - transaction transaction name (within this handler)
        code - the code from which the message is needed
        Returns:
        the code to place within outcomeDetail (Logbooks)

      • getOutcomeDetailLfc

        public static final java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler,
                                                         java.lang.String transaction,
                                                         java.lang.String detailedOutcome,
                                                         StatusCode code)
        Parameters:
        stepOrHandler - step or handler name or full name
        transaction - transaction transaction name (within this handler)
        detailedOutcome - the detailed outcome for the transaction
        code - the code from which the message is needed
        Returns:
        the code to place within outcomeDetail (Logbooks)

      • getOutcomeDetailLfc

        public static final java.lang.String getOutcomeDetailLfc​(java.lang.String stepOrHandler,
                                                         java.lang.String transaction,
                                                         StatusCode code)
        Parameters:
        stepOrHandler - step or handler name or full name
        transaction - transaction transaction name (within this handler)
        code - the code from which the message is needed
        Returns:
        the code to place within outcomeDetail (Logbooks)

      • getCodeOp

        public static final java.lang.String getCodeOp​(java.lang.String stepOrHandler,
                                               StatusCode code)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        code - the code from which the message is needed
        Returns:
        the code label of this step or handler or full named

      • getCodeLfc

        public static final java.lang.String getCodeLfc​(java.lang.String stepOrHandler,
                                                StatusCode code)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        code - the code from which the message is needed
        Returns:
        the code label of this step or handler or full named

      • getCodeOp

        public static final java.lang.String getCodeOp​(java.lang.String stepOrHandler,
                                               java.lang.String transaction,
                                               StatusCode code)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        code - the code from which the message is needed
        Returns:
        the code label of this step or handler or full named with sub transaction

      • getCodeLfc

        public static final java.lang.String getCodeLfc​(java.lang.String stepOrHandler,
                                                java.lang.String transaction,
                                                StatusCode code)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        code - the code from which the message is needed
        Returns:
        the code label of this step or handler or full named with sub transaction

      • getCodeOp

        public static final java.lang.String getCodeOp​(java.lang.String stepOrHandler,
                                               StatusCode code,
                                               java.lang.Object... args)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        code - the code from which the message is needed
        args - list of extra argument to apply as MessageFormat.format(message, args)
        Returns:
        the code label of this step or handler or full named

      • getCodeLfc

        public static final java.lang.String getCodeLfc​(java.lang.String stepOrHandler,
                                                StatusCode code,
                                                java.lang.Object... args)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        code - the code from which the message is needed
        args - list of extra argument to apply as MessageFormat.format(message, args)
        Returns:
        the code label of this step or handler or full named

      • getCodeOp

        public static final java.lang.String getCodeOp​(java.lang.String stepOrHandler,
                                               java.lang.String transaction,
                                               StatusCode code,
                                               java.lang.Object... args)
        Operation Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        code - the code from which the message is needed
        args - list of extra argument to apply as MessageFormat.format(message, args)
        Returns:
        the code label of this step or handler or full named with sub transaction

      • getCodeLfc

        public static final java.lang.String getCodeLfc​(java.lang.String stepOrHandler,
                                                java.lang.String transaction,
                                                StatusCode code,
                                                java.lang.Object... args)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        code - the code from which the message is needed
        args - list of extra argument to apply as MessageFormat.format(message, args)
        Returns:
        the code label of this step or handler or full named with sub transaction

      • getCodeLfc

        public static final java.lang.String getCodeLfc​(java.lang.String stepOrHandler,
                                                java.lang.String transaction,
                                                java.lang.String detailedOutcome,
                                                StatusCode code,
                                                java.lang.Object... args)
        Lifecycle Logbook context
        Parameters:
        stepOrHandler - step or handler name or full name (on Front Office Application)
        transaction - transaction name (within this handler)
        detailedOutcome - the detailed outcome for the transaction
        code - the code from which the message is needed
        args - list of extra argument to apply as MessageFormat.format(message, args)
        Returns:
        the code label of this step or handler or full named with sub transaction

      • getFromFullCodeKey

        public static final java.lang.String getFromFullCodeKey​(java.lang.String completeCodeKey)
        Get a message labe knowing its full code key
        Parameters:
        completeCodeKey - the key of the label to be retrieved
        Returns:
        the label of a particular full code key

      • getFromFullCodeKey

        public static final java.lang.String getFromFullCodeKey​(java.lang.String completeCodeKey,
                                                        java.lang.Object... args)

      • getSeparator

        public static final java.lang.String getSeparator()
        Returns:
        String

      • containsKey

        public static final boolean containsKey​(java.lang.String key)
        Parameters:
        key -
        Returns:
        boolean true/false