Package fr.gouv.vitam.common.i18n
Class VitamLogbookMessages
java.lang.Object
fr.gouv.vitam.common.i18n.VitamLogbookMessages
Vitam Messages Helper for Logbooks
-
Method Summary
Modifier and TypeMethodDescriptionstatic final booleancontainsKey(String key) Retrieve all the messagesstatic final StringgetCodeLfc(String stepOrHandler, StatusCode code) Lifecycle Logbook contextstatic final StringgetCodeLfc(String stepOrHandler, StatusCode code, Object... args) Lifecycle Logbook contextstatic final StringgetCodeLfc(String stepOrHandler, String transaction, StatusCode code) Lifecycle Logbook contextstatic final StringgetCodeLfc(String stepOrHandler, String transaction, StatusCode code, Object... args) Lifecycle Logbook contextstatic final StringgetCodeLfc(String stepOrHandler, String transaction, String detailedOutcome, StatusCode code, Object... args) Lifecycle Logbook contextstatic final StringgetCodeOp(String stepOrHandler, StatusCode code) Operation Logbook contextstatic final StringgetCodeOp(String stepOrHandler, StatusCode code, Object... args) Operation Logbook contextstatic final StringgetCodeOp(String stepOrHandler, String transaction, StatusCode code) Operation Logbook contextstatic final StringgetCodeOp(String stepOrHandler, String transaction, StatusCode code, Object... args) Operation Logbook contextstatic final StringgetEventTypeLfc(String stepOrHandler) static final StringgetEventTypeStarted(String stepOrHandler) static final StringgetFromFullCodeKey(String completeCodeKey) Get a message labe knowing its full code keystatic final StringgetFromFullCodeKey(String completeCodeKey, Object... args) static final StringgetLabelLfc(String stepOrHandler) Lifecycle Logbook contextstatic final StringgetLabelLfc(String stepOrHandler, String transaction) Lifecycle Logbook contextstatic final StringgetLabelOp(String stepOrHandler) Operation Logbook contextstatic final StringgetLabelOp(String stepOrHandler, String transaction) Operation Logbook contextstatic final StringgetOutcomeDetail(String stepOrHandler, StatusCode code) static final StringgetOutcomeDetail(String stepOrHandler, String transaction, StatusCode code) static final StringgetOutcomeDetailLfc(String stepOrHandler, StatusCode code) static final StringgetOutcomeDetailLfc(String stepOrHandler, String transaction, StatusCode code) static final StringgetOutcomeDetailLfc(String stepOrHandler, String transaction, String detailedOutcome, StatusCode code) static final Stringstatic final StringgetSubTaskEventTypeLfc(String stepOrHandler, String subTaskName) static final StringgetSubTaskEventTypeOp(String stepOrHandler, String subTaskName)
-
Method Details
-
getAllMessages
Retrieve all the messages- Returns:
- map of messages
-
getLabelOp
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
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
- Parameters:
stepOrHandler- step or handler name or full name- Returns:
- the final EventType code
-
getEventTypeLfc
- Parameters:
stepOrHandler- step or handler name or full name- Returns:
- the final EventType code
-
getSubTaskEventTypeLfc
- Parameters:
stepOrHandler- step or handler name or full namesubTaskName- name of the sub task- Returns:
- the final EventType code
-
getSubTaskEventTypeOp
- Parameters:
stepOrHandler- step or handler name or full namesubTaskName- name of the sub task- Returns:
- the final EventType code
-
getLabelOp
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
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
- Parameters:
stepOrHandler- step or handler name or full namecode- the code from which the message is needed- Returns:
- the code to place within outcomeDetail (Logbooks)
-
getOutcomeDetailLfc
- Parameters:
stepOrHandler- step or handler name or full namecode- of status- Returns:
- the code to place within outcomeDetail (Logbooks)
-
getOutcomeDetail
public static final String getOutcomeDetail(String stepOrHandler, String transaction, StatusCode code) - Parameters:
stepOrHandler- step or handler name or full nametransaction- 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 String getOutcomeDetailLfc(String stepOrHandler, String transaction, String detailedOutcome, StatusCode code) - Parameters:
stepOrHandler- step or handler name or full nametransaction- transaction transaction name (within this handler)detailedOutcome- the detailed outcome for the transactioncode- the code from which the message is needed- Returns:
- the code to place within outcomeDetail (Logbooks)
-
getOutcomeDetailLfc
public static final String getOutcomeDetailLfc(String stepOrHandler, String transaction, StatusCode code) - Parameters:
stepOrHandler- step or handler name or full nametransaction- transaction transaction name (within this handler)code- the code from which the message is needed- Returns:
- the code to place within outcomeDetail (Logbooks)
-
getCodeOp
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
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
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
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
Operation Logbook context- Parameters:
stepOrHandler- step or handler name or full name (on Front Office Application)code- the code from which the message is neededargs- list of extra argument to apply as MessageFormat.format(message, args)- Returns:
- the code label of this step or handler or full named
-
getCodeLfc
Lifecycle Logbook context- Parameters:
stepOrHandler- step or handler name or full name (on Front Office Application)code- the code from which the message is neededargs- 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 String getCodeOp(String stepOrHandler, String transaction, StatusCode code, 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 neededargs- 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 String getCodeLfc(String stepOrHandler, String transaction, StatusCode code, 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 neededargs- 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 String getCodeLfc(String stepOrHandler, String transaction, String detailedOutcome, StatusCode code, 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 transactioncode- the code from which the message is neededargs- 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
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
-
getSeparator
- Returns:
- String
-
containsKey
- Parameters:
key-- Returns:
- boolean true/false
-