Interface IExportControl40BF
-
@BusinessFacade public interface IExportControl40BF
The business facade interface for export control.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ECCustomsInfoResultDTO
addCustomsInfo(ECCustomsInfoDTO customsInfo, ECParmsDTO parms)
Deprecated.As of 2019/05.CreateQuestionnaireResponseDTO
createQuestionnaire(CreateQuestionnaireRequestDTO request)
Deprecated.Only useful in conjunction withdoExportControlChecks(ECTransactionDTO, ECParmsDTO)
, which itself is deprecated.ECTotalCheckResultDTO
doExportControlChecks(ECTransactionDTO transaction, ECParmsDTO parms)
Deprecated.As of 2019/05.ECDoExportControlChecksResponseDTO
doExportControlChecksV2(ECDoExportControlChecksRequestDTO request)
Deprecated.As of 2020/08.ECClearingResponseDTO
getClearingForId(ECClearingReferenceDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05.ECGetJurisdictionsResponseDTO
getJurisdictions(ECGetJurisdictionsRequestDTO request)
Returns the jurisdictions (aka plugins) for a client.
This includes: predefined jurisdictions (visible for all clients) self defined jurisdictions only visible for a clientECPluginDTO[]
getLicensedPlugins()
Deprecated.As of 2016/05.LMLicenseInfoResponseDTO
getLicenseInfos(LMLicenseInfoRequestDTO request)
Get information about the licenses referenced by the given license references.ECGetRelevantClassificationsResponseDTO
getRelevantClassifications(ECGetRelevantClassificationsRequestDTO request)
Returns all relevant classifications of a jurisdiction that is configured in a compliance profile.ECClearingResponseDTO
handleClearing(ECClearingRequestDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05.LMProposeLicensesResponseDTO
proposeLicenses(LMProposeLicensesRequestDTO request)
Returns the proposed licenses for the given transaction items.LMProposeLicensesCompactResponseDTO
proposeLicensesCompact(LMProposeLicensesCompactRequestDTO request)
Compact variant ofproposeLicenses(LMProposeLicensesRequestDTO)
.SetECMaterialMasterFileDataResponseDTO
setECMaterialMasterFileData(SetECMaterialMasterFileDataRequestDTO request)
Create or update multiple material classifications in the master file data of the engine.
Because of performance and transactional issues it is recommended to transfer about 100 material classifications within one synchronous call.ECUnfinalizeClearingResponseDTO
unfinalizeClearing(ECUnfinalizeClearingRequestDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05.
-
-
-
Method Detail
-
getLicensedPlugins
@Deprecated ECPluginDTO[] getLicensedPlugins()
Deprecated.As of 2016/05. UsegetJurisdictions(ECGetJurisdictionsRequestDTO)
instead.Returns the licensed plugins.- Returns:
- Array of ECPluginDTOs Contains one entry for every licensed export control plugin.
-
getJurisdictions
ECGetJurisdictionsResponseDTO getJurisdictions(ECGetJurisdictionsRequestDTO request)
Returns the jurisdictions (aka plugins) for a client.
This includes:- predefined jurisdictions (visible for all clients)
- self defined jurisdictions only visible for a client
- Parameters:
request
- The request, which specifies for which client the jurisdictions should be returned.- Returns:
- Information about the jurisdictions for a client.
-
getRelevantClassifications
ECGetRelevantClassificationsResponseDTO getRelevantClassifications(ECGetRelevantClassificationsRequestDTO request)
Returns all relevant classifications of a jurisdiction that is configured in a compliance profile.- Parameters:
request
- The request, which specifies for which jurisdiction the relevant classifications should be returned.- Returns:
- The relevant classifications of a jurisdiction that is configured in a compliance profile.
-
doExportControlChecks
@Deprecated ECTotalCheckResultDTO doExportControlChecks(ECTransactionDTO transaction, ECParmsDTO parms)
Deprecated.As of 2019/05. UseIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
instead.Do an export control check for a transaction.- Parameters:
transaction
- Data of the transactionparms
- Common parameters- Returns:
- The result of the export control check
-
doExportControlChecksV2
@Deprecated ECDoExportControlChecksResponseDTO doExportControlChecksV2(ECDoExportControlChecksRequestDTO request)
Deprecated.As of 2020/08. UseIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
instead.Do an export control check for a transaction similar todoExportControlChecks(ECTransactionDTO, ECParmsDTO)
, but this one only requires one request DTO with all parameters and returns a response DTO.
This method handles validation errors and warnings more gracefully by returning them in the response DTO, instead of just throwing an exception.- Parameters:
request
- Data of the transaction and parameters- Returns:
- The result of the export control check
-
proposeLicenses
LMProposeLicensesResponseDTO proposeLicenses(LMProposeLicensesRequestDTO request)
Returns the proposed licenses for the given transaction items.
For every given jurisdiction in each item, the applicable licenses will be determined and returned. Depending on the parameter
LMProposeLicensesRequestDTO.onlyMatching
, the returned licenses may either completely match the transaction items or only match in very basic criteria like client, status, etc.You can reduce the number of returned licenses by implementing filters (see
LMProposeLicensesRequestDTO.licenseFilters
.If data driven access rights are defined for Licenses of this client, these are considered by this call.
- Parameters:
request
- Common parameters and the transaction items to propose licenses for.- Returns:
- The proposed licenses.
- Since:
- 2016/05
-
proposeLicensesCompact
LMProposeLicensesCompactResponseDTO proposeLicensesCompact(LMProposeLicensesCompactRequestDTO request)
Compact variant of
proposeLicenses(LMProposeLicensesRequestDTO)
. It is designed for systems with large sets of active licenses. With the regular method, these could lead to very large result sets that need to be transfered to and processed by the host system.It should be used as follows:
- To get a notion about the number of returned licenses, you get this
information from
LMProposeLicensesCompactResponseItemDTO.proposedLicensesCount
. - To build a simple overview with the most important data of proposed
licenses resp. license items, use the
LMLicenseCompactInfoDTO.infoLine
resp. theLMLicenseCompactInfoDTO.licenseItemsInfoLines
for each license. - To get all information about a certain license (e.g. initiated by user
action in the host system), uncompress and deserialize the information found
in
LMLicenseCompactInfoDTO.lmLicenseInfoDTOCompressed
.
Note that you can reduce the number of returned licenses in a functional way by implementing filters (see
LMProposeLicensesRequestDTO.licenseFilters
).If data driven access rights are defined for Licenses of this client, these are considered by this call.
- Parameters:
request
- Common parameters and the transaction items to propose licenses for.- Returns:
- The proposed licenses in a compact variant
- Since:
- 2017/02
- To get a notion about the number of returned licenses, you get this
information from
-
getLicenseInfos
LMLicenseInfoResponseDTO getLicenseInfos(LMLicenseInfoRequestDTO request)
Get information about the licenses referenced by the given license references.
If data driven access rights are defined for Licenses of this client, these are considered by this call.
- Parameters:
request
- Common parameters and license references.- Returns:
- The information about the licenses.
- Since:
- 2016/05
-
handleClearing
@Deprecated ECClearingResponseDTO handleClearing(ECClearingRequestDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05. No longer required because the approval management takes place directly in Export Controls (seeIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
).Create, modify or delete an approval that will clear an export restriction from the export control check.- Parameters:
request
- to be handledparms
- Common parameters- Returns:
- result The approval with the information which fields are mandatory/optional/forbidden. May be null if there has been an error.
-
getClearingForId
@Deprecated ECClearingResponseDTO getClearingForId(ECClearingReferenceDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05. No longer required because the approval management takes place directly in Export Controls (seeIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
).Get the approval assigned to the id.- Parameters:
request
- Contains information about the searched approval.parms
- Common parameters- Returns:
- result The approval searched for. A error flag and error text is set, if something goes wrong or the approval does not exist.
-
addCustomsInfo
@Deprecated ECCustomsInfoResultDTO addCustomsInfo(ECCustomsInfoDTO customsInfo, ECParmsDTO parms)
Deprecated.As of 2019/05. No longer required because the approval management takes place directly in Export Controls (seeIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
).Modify an approval for the last missing values to complete the approval.- Parameters:
customsInfo
- data to update the approval withparms
- Common parameters- Returns:
- result The result of the action. A error flag and error text is set, if something goes wrong.
-
setECMaterialMasterFileData
SetECMaterialMasterFileDataResponseDTO setECMaterialMasterFileData(SetECMaterialMasterFileDataRequestDTO request)
Create or update multiple material classifications in the master file data of the engine.
Because of performance and transactional issues it is recommended to transfer about 100 material classifications within one synchronous call.
All transfered material classifications will be either created or updated. TheECMaterialMFDDTO.materialId
will be checked before processing. In case of any unfilledECMaterialMFDDTO.materialId
, nothing will be done.
In case of other problems for a single material classification, e.g locking, the processing is usually continued with the next material classification, skipping the problematic material classification. This means the record will be skipped completely and processing will continue with the next material classification. Such errors will set the response'shasErrors
orhasWarnings
fields totrue
. To analyze the situations check the response for details.- Parameters:
request
- Specifies which material classifications to be updated.- Returns:
- Information about the update process.
-
unfinalizeClearing
@Deprecated ECUnfinalizeClearingResponseDTO unfinalizeClearing(ECUnfinalizeClearingRequestDTO request, ECParmsDTO parms)
Deprecated.As of 2019/05. No longer required because the approval management takes place directly in Export Controls (seeIExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO)
).Resets a finalized approval, so that is not finalized afterwards. All other data of the approval keep unchanged. A not yet finalized approval will be ignored without any errors.- Parameters:
request
- contains information about the approval to modifyparms
- common parameters- Returns:
- the result of processing the request. Errors are indicated by an error flag and an error message.
- Since:
- 2015/10
-
createQuestionnaire
@Deprecated CreateQuestionnaireResponseDTO createQuestionnaire(CreateQuestionnaireRequestDTO request)
Deprecated.Only useful in conjunction withdoExportControlChecks(ECTransactionDTO, ECParmsDTO)
, which itself is deprecated. Only to be used in migration phase to new BF.Forces creation of a new questionnaire for a transaction. In case other questionnaires already exist for the given transaction, they are marked as invalid and the newly created questionnaire becomes the active one for that transaction.- Parameters:
request
- Specifies the transaction, for which the questionnaire should be created and what questionnaire to create.- Returns:
- The result of the action. Empty, if a questionnaire was created successfully.
-
-