Package de.aeb.xnsg.expctrl.bf.v40
Class ECParmsDTO
- java.lang.Object
-
- de.aeb.xnsg.expctrl.bf.v40.ECParmsDTO
-
public class ECParmsDTO extends Object
Parameters for the export control checks.
-
-
Field Summary
Fields Modifier and Type Field Description String
clientIdentCode
The client to take settings from.
Example value:"APITEST"
String
clientSystemId
A unique name of the host system (e.g.CreateRAQuestionnaireFromECTransactionDTO
createQuestionnaireParms
Deprecated.As of 2019/11.Boolean
isAddAddlOptionsAtLicProposal
Defines that further license options like a blank license or NLR (no license required) should be included in the set of licenses returned by license proposal.Boolean
isAutoCreateClearings
Defines that the transaction can be automatically approved, if a applicable license is found.Boolean
isAutoUpdateClearings
Iftrue
, any approvals referenced byECItemDTO.uniqueClearingIds
, will be updated with the data of theECItemDTO's
passed, unless the approval is already finalized.Boolean
isCompareWithClearings
Iftrue
, any approvals referenced byECItemDTO.uniqueClearingIds
will be compared with the data of theECItemDTO's
passed.Boolean
isSuppressedLicenseProposal
Defines if the license proposal should be suppressed for the export control check.
Iftrue
, no licenses will be checked for availability/applicability!
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
Default value:false
Boolean
isSuppressedProtocolling
Defines if the logging should be suppressed for the export control check.
Iftrue
there will be no logging!
Default value:false
, means logging is controlled by profile.String[]
languages
The constantsde
oren
for the languages of the strings in the result.String
profileIdentCode
The ID of the compliance profile to take settings from.
Example value:"DEFAULT"
ECRiskAssessmentParmsDTO
riskAssessmentParms
Parameters to integrate Risk Assessment functionality in the export control check.
This field is used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
andIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
.
In the callIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
these parameters could be omitted if the Risk Assessment integration in the export control check is not needed.
In the callIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
these parameters should be filled if an approval forECConstants.PLUGIN_IDENTCODE_RISK_ASSESSMENT
jurisdiction is created.Boolean
todoForMandatoryFields
Deprecated.As of 2016/05.String
userIdentification
The user name to be used for logging and for determination of the user's roles.
It is not required, that this user is a valid user name of the client.
-
Constructor Summary
Constructors Constructor Description ECParmsDTO()
-
-
-
Field Detail
-
clientIdentCode
public String clientIdentCode
The client to take settings from.
Example value:"APITEST"
-
profileIdentCode
public String profileIdentCode
The ID of the compliance profile to take settings from.
Example value:"DEFAULT"
-
clientSystemId
public String clientSystemId
A unique name of the host system (e.g. Plug-in for SAP® or ASSIST4) sending the request to the business facade for logging purposes.
Example value:"API-TEST"
-
languages
public String[] languages
The constantsde
oren
for the languages of the strings in the result. More than one language is possible.
-
userIdentification
public String userIdentification
The user name to be used for logging and for determination of the user's roles.
It is not required, that this user is a valid user name of the client. However such a user may be granted to have only the roleI_EVERYONE
.
Example value:"TESTUSER"
Maximum length:100
-
isSuppressedProtocolling
public Boolean isSuppressedProtocolling
Defines if the logging should be suppressed for the export control check.
Iftrue
there will be no logging!
Default value:false
, means logging is controlled by profile.
-
isSuppressedLicenseProposal
public Boolean isSuppressedLicenseProposal
Defines if the license proposal should be suppressed for the export control check.
Iftrue
, no licenses will be checked for availability/applicability!
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
Default value:false
- Since:
- 2016/05
-
isAutoCreateClearings
public Boolean isAutoCreateClearings
Defines that the transaction can be automatically approved, if a applicable license is found. If the transaction can be approved automatically, an approval is automatically created per jurisdiction and the transaction is no longer blocked.
An automatic approval of the transaction is only performed if exactly one suitable license is found with exactly one matching item for one transaction per jurisdiction. Furthermore, an transaction can only be approved automatically if there are no applicable general licenses from the AEB data service.
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
.
-
isAutoUpdateClearings
public Boolean isAutoUpdateClearings
Iftrue
, any approvals referenced byECItemDTO.uniqueClearingIds
, will be updated with the data of theECItemDTO's
passed, unless the approval is already finalized. So no additional calls toIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
are necessary to fill the approvals with actual data from the transaction.
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
Default value:false
(since this was the implicit behavior before 2016/05)- Since:
- 2016/05
-
isCompareWithClearings
public Boolean isCompareWithClearings
Iftrue
, any approvals referenced byECItemDTO.uniqueClearingIds
will be compared with the data of theECItemDTO's
passed. If some partner or product classifications differ, the approval can not release an export control result.
Setting this flag is usually only useful ifisAutoUpdateClearings=false
and approvals are not automatically updated when transaction data changes. Regardless, setting it will prevent that finalized approvals (which can not be auto-updated) can clear a transaction if the transaction data has meanwhile changed.
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
Default value:false
(since this was the implicit behavior before 2016/05)- Since:
- 2016/05
-
todoForMandatoryFields
@Deprecated public Boolean todoForMandatoryFields
Deprecated.As of 2016/05.Defines if mandatory fields in an approval should lead to 'Todo' or 'Info' in the ec check result.
Default value:false
, means mandatory fields lead to 'Info' in check result.
-
isAddAddlOptionsAtLicProposal
public Boolean isAddAddlOptionsAtLicProposal
Defines that further license options like a blank license or NLR (no license required) should be included in the set of licenses returned by license proposal. These licenses are not suggested.
A blank license is indicated by licenseId and licenseNumber not specified inECAvailableLicenseDTO
, i.e. is only a template for a not yet specified license. To use this license for the next request at least the license number has to be specified. If the request isIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
the license number references a license maintained in License Management or (if no such license found) a license not maintained in Trade Compliance Management.
This option is considered for the license proposal ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
.
Default value:true
(since this was the implicit behavior before 2016/05)- Since:
- 2016/05
-
createQuestionnaireParms
@Deprecated public CreateRAQuestionnaireFromECTransactionDTO createQuestionnaireParms
Deprecated.As of 2019/11. UseriskAssessmentParms
instead.Parameters which are needed to trigger a creation of an Risk Assessment questionnaire.
This field is only used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
.- Since:
- 2019/09
-
riskAssessmentParms
public ECRiskAssessmentParmsDTO riskAssessmentParms
Parameters to integrate Risk Assessment functionality in the export control check.
This field is used in calls ofIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
andIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
.
In the callIExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)
these parameters could be omitted if the Risk Assessment integration in the export control check is not needed.
In the callIExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO)
these parameters should be filled if an approval forECConstants.PLUGIN_IDENTCODE_RISK_ASSESSMENT
jurisdiction is created.- Since:
- 2019/11
-
-