InterfaceParametersProvider (Plugin API FirehoseOrder 1.15 API)

All Known Implementing Classes:

InterfaceParametersProviderDefaultImpl
```
public interface InterfaceParametersProvider
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`getBatchSize()`
`boolean`	`getBooleanParameter(String paramKey, boolean defaultValue)`
`default Long`	`getCurrentExecutionId()`
`default Long`	`getCurrentInterfaceId()`
`default String`	`getCurrentOperator()` Returns the code of the current logged in operator in S-360.
`default Long`	`getCurrentScheduleId()`
`String`	`getInstitutionCode()`
`Map<String,String>`	`getInterfaceParameters()` Deprecated.
`Locale`	`getLocale()`
`String`	`getLogin()`
`default String`	`getOrganizationCode()`
`default Long`	`getOrganizationId()`
`default TimeZone`	`getOrganizationTimeZone()` Get the organization time zone.
`String`	`getPassword()`
`String`	`getUrl()`
`boolean`	`isDummyMode()`
`default boolean`	`isFileProvidedForBatch()`
`default Date`	`readExecutionDateForCurrentBatch()`
`int`	`readIntegerParameter(String paramKey, int defaultValue)`
`default Date`	`readLastSuccessfullExecutionDateForCurrentBatch(boolean considerSchedule)` Returns the last successfull execution date for the current batch.
`long`	`readLongParameter(String paramKey, long defaultValue)`
`List<String>`	`readStringListParameter(String paramKey, List<String> defaultValue)`
`String`	`readStringParameter(String paramKey, String defaultValue)`
`default Optional<List<String>>`	`readUploadedFileContent(String charset)`
`default Optional<String>`	`readUploadedFileName()`
`default void`	`storeIntegerParameter(String paramKey, int value)`
`default void`	`storeStringParameter(String paramKey, String value)`

Method Detail

getInterfaceParameters

@Deprecated
Map<String,String> getInterfaceParameters()

Deprecated.

getUrl
```
String getUrl()
```

getLogin
```
String getLogin()
```

getPassword
```
String getPassword()
```

isDummyMode
```
boolean isDummyMode()
```

getLocale
```
Locale getLocale()
```

getInstitutionCode
```
String getInstitutionCode()
```

getBatchSize
```
Integer getBatchSize()
```

readIntegerParameter

int readIntegerParameter(String paramKey,
                         int defaultValue)

readStringParameter

String readStringParameter(String paramKey,
                           String defaultValue)

readStringListParameter

List<String> readStringListParameter(String paramKey,
                                     List<String> defaultValue)

readLongParameter

long readLongParameter(String paramKey,
                       long defaultValue)

getBooleanParameter

boolean getBooleanParameter(String paramKey,
                            boolean defaultValue)

readUploadedFileContent

default Optional<List<String>> readUploadedFileContent(String charset)

readUploadedFileName

default Optional<String> readUploadedFileName()

getOrganizationCode
```
default String getOrganizationCode()
```

getOrganizationId
```
default Long getOrganizationId()
```

isFileProvidedForBatch

default boolean isFileProvidedForBatch()

storeIntegerParameter

default void storeIntegerParameter(String paramKey,
                                   int value)

storeStringParameter

default void storeStringParameter(String paramKey,
                                  String value)

readLastSuccessfullExecutionDateForCurrentBatch
```
default Date readLastSuccessfullExecutionDateForCurrentBatch(boolean considerSchedule)
```
Returns the last successfull execution date for the current batch. This method works only when called from a plugin method which is a batch function.

Parameters:

considerSchedule - if set to true, the date of last execution will only consider the current schedule. Recommandation: set to true if you do not know what to put.

Returns:

date of last execution for current batch.

getCurrentOperator
```
default String getCurrentOperator()
```
Returns the code of the current logged in operator in S-360.

Returns:

getCurrentInterfaceId
```
default Long getCurrentInterfaceId()
```

getCurrentExecutionId
```
default Long getCurrentExecutionId()
```

getCurrentScheduleId
```
default Long getCurrentScheduleId()
```

getOrganizationTimeZone
```
default TimeZone getOrganizationTimeZone()
```
Get the organization time zone.

Returns:

the organisation time zone.

readExecutionDateForCurrentBatch

default Date readExecutionDateForCurrentBatch()

Interface InterfaceParametersProvider

Method Summary

Method Detail

getInterfaceParameters

getUrl

getLogin

getPassword

isDummyMode

getLocale

getInstitutionCode

getBatchSize

readIntegerParameter

readStringParameter

readStringListParameter

readLongParameter

getBooleanParameter

readUploadedFileContent

readUploadedFileName

getOrganizationCode

getOrganizationId

isFileProvidedForBatch

storeIntegerParameter

storeStringParameter

readLastSuccessfullExecutionDateForCurrentBatch

getCurrentOperator

getCurrentInterfaceId

getCurrentExecutionId

getCurrentScheduleId

getOrganizationTimeZone

readExecutionDateForCurrentBatch