Click or drag to resize

IGroupAdapter Interface

Group Adapter Interface

Namespace:  PSI.Sox.Adapter.Interfaces
Assembly:  PSI.Sox (in PSI.Sox.dll) Version: 2.1
Syntax
C#
public interface IGroupAdapter : IAdapter, 
	IDisposable

The IGroupAdapter type exposes the following members.

Properties
  NameDescription
Public propertyAdapterConfiguration
Gets or sets AdapterConfiguration.
(Inherited from IAdapter.)
Public propertyAdapterDataHelper
Shipping Adapter Data Helper
Public propertyAdapterId
unique adapter id
(Inherited from IAdapter.)
Public propertyAdapterName
Gets the Adapter Name
(Inherited from IAdapter.)
Public propertyAdapterSymbol
Gets the adapter symbol, used to set the adapter prefix
(Inherited from IAdapter.)
Public propertyAdapterVersion
Get the Adapter Version.
(Inherited from IAdapter.)
Public propertyCompanyName
Returns the adapter company name
(Inherited from IAdapter.)
Public propertyLogger
Gets the instance of ILogger.
(Inherited from IAdapter.)
Public propertyProxySettings
Gets or sets ProxySettings.
(Inherited from IAdapter.)
Top
Methods
  NameDescription
Public methodAddShipmentToGroup
Adds Shipment to group
Public methodCloseGroup
Closes the specified group.
Public methodCreateGroup
Creates a group with associated data
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetCarriers
Gets a list of Carriers
Public methodGetDocuments
Client interface that gets Symbol/FriendlyName pairs of available Group Documents by Carrier.
Public methodGetGroup
Gets group information based on the provided parameters.
Public methodGetGroups
Gets a list of Groups based on the provided parameters.
Public methodGetGroupTypes
Gets a list of grouping types
Public methodInit
Initializes adapter
(Inherited from IAdapter.)
Public methodModifyGroup
Modifies the data associated in a specific group
Public methodModifyPackageLabel
modifies the package label for grouping
Public methodOpenGroup
Re-opens the specified group.
Public methodPrintGroupDocument
Print group document
Top
See Also