Interface EDIConfigService
- All Superinterfaces:
Service
public interface EDIConfigService extends Service
- autogenerate a ConfigName using all the EDI Ids
- find partner given a set of EDI Ids or master
- find the master (VendorMaster or CustomerMaster) given a configName or partner
- find the EdiConfig record given a set of EDI Ids or configName or partner
- find the Ediconfig record given edi messaging context which has edi sender receiver identifier details
-
Method Summary
Modifier and Type Method Description java.lang.String
generateConfigName(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)
This method generates the configName using the set of IDs.java.util.List<EdiConfig>
getEdiConfigs(Partner partner, PlatformUserContext pltUsrContext)
This method finds the EdiConfig records associated with the partner.java.util.List<EdiConfig>
getEdiConfigs(EDIMessagingContext ediMessagingContext)
This method finds the EdiConfig records associated with the EDI Identifiers and the partner by using ediMessagingContext;java.util.List<EdiConfig>
getEdiConfigs(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)
This method finds the EdiConfig records associated with the EDI Ids.java.util.List<EdiConfig>
getEdiConfigs(java.lang.String configName, java.lang.String owningEntName, PlatformUserContext pltUsrContext)
This method finds the EdiConfig records associated with the configName.java.util.List<EdiConfig>
getEdiConfigsByMaster(Partner master, PlatformUserContext pltUsrContext)
Returns the EdiConfig records setup for a master - like VendorMaster or CustomerMaster.java.util.List<Partner>
getPartners(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)
This method finds the EdiConfig records associated with the set of EDI Ids and returns the corresponding partner records.java.util.List<EdiConfig>
getPrimaryEdiConfigForInbound(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)
This method finds the primary inbound EdiConfig associated with the EDI Ids.java.util.List<EdiConfig>
getPrimaryEdiConfigForOutbound(Partner partner, PlatformUserContext pltUsrContext)
This method finds the primary outbound EdiConfig associated with the partner.
-
Method Details
-
getEdiConfigs
java.util.List<EdiConfig> getEdiConfigs(java.lang.String configName, java.lang.String owningEntName, PlatformUserContext pltUsrContext)This method finds the EdiConfig records associated with the configName.- Parameters:
configName
-owningEntName
-pltUsrContext
-PlatformUserContext
- Returns:
- List<
EdiConfig
>
-
getEdiConfigs
java.util.List<EdiConfig> getEdiConfigs(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)This method finds the EdiConfig records associated with the EDI Ids.- Parameters:
pltUsrContext
-PlatformUserContext
- Returns:
- List<
EdiConfig
>
-
getEdiConfigs
This method finds the EdiConfig records associated with the partner.- Parameters:
partner
-pltUsrContext
-PlatformUserContext
- Returns:
- List<
EdiConfig
>
-
getPrimaryEdiConfigForInbound
java.util.List<EdiConfig> getPrimaryEdiConfigForInbound(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)This method finds the primary inbound EdiConfig associated with the EDI Ids.- Parameters:
pltUsrContext
-PlatformUserContext
- Returns:
- List<
EdiConfig
>
-
getPrimaryEdiConfigForOutbound
java.util.List<EdiConfig> getPrimaryEdiConfigForOutbound(Partner partner, PlatformUserContext pltUsrContext)This method finds the primary outbound EdiConfig associated with the partner.- Parameters:
partner
-pltUsrContext
-PlatformUserContext
- Returns:
- List<
EdiConfig
>
-
generateConfigName
java.lang.String generateConfigName(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)This method generates the configName using the set of IDs. Modules must use#getEdiConfig(String, PlatformUserContext)
to check if there is an EdiConfig record existing for the configName generated before updating.- Parameters:
pltUsrContext
-PlatformUserContext
- Returns:
- configName generated from the Ids.
-
getPartners
java.util.List<Partner> getPartners(InterchangeInfo interchangeInfo, PlatformUserContext pltUsrContext)This method finds the EdiConfig records associated with the set of EDI Ids and returns the corresponding partner records. Null otherwise.- Parameters:
pltUsrContext
-PlatformUserContext
- Returns:
- List<
Partner
>
-
getEdiConfigsByMaster
Returns the EdiConfig records setup for a master - like VendorMaster or CustomerMaster.The EDIConfig setup under a partnership can either be applied to all Masters under the corresponding umbrella or can be applied to specific Master records under a partnership.
For example, an EDIConfig setup for a Customer Partner can be applicable all CustomerMaster records or it can be specifically applied to one CustomerMaster record.
If no config was setup for a specific master, then the generic config that applies to all masters in the category is returned.
- Parameters:
master
-pltUsrContext
-- Returns:
- List<
EdiConfig
>
-
getEdiConfigs
This method finds the EdiConfig records associated with the EDI Identifiers and the partner by using ediMessagingContext;Edi sender/receiver identifier details are initially populated on EDIMessagingContext so its not necessary to relay on partner. as in some cases Partner would be null.
.In some cases edi config name is not in expected format like (ISASenderQual/ISASenderId/GSSenderId_ISAReceiverQual/ISAReceiverId/GSReceiverId) hence this method won't take config name as input.
This method takes input as edi ISA/GS sender/receiver ids and qualifier details from edi messaging context and Partner if not null
- Returns:
- List<
EdiConfig
> returns list of matching edi config records
-