Class SimpleShipmentProvider
Archive provider for the list of mailings
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("simpleshipment", 1073741823)]
public class SimpleShipmentProvider : TypedQueryProviderBase<ArchiveRow, MailingsMailingsExtender>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveTypedProvider<ArchiveRow>, IArchiveTypedProviderBase, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntitiesConstructors
SimpleShipmentProvider()
Archive provider for the list of mailings
Declaration
protected SimpleShipmentProvider()Fields
ProviderName
Archive provider for the list of mailings
Declaration
public const string ProviderName = "simpleshipment"Field Value
| Type | Description |
|---|---|
| string |
RowTypeAll
Archive provider for the list of mailings
Declaration
public const string RowTypeAll = "all"Field Value
| Type | Description |
|---|---|
| string |
Methods
AcceptRow(SoDataReader)
Decide whether the current row of the passed-in _reader should be accepted or not. If false is returned, this row is skipped by the base class and never seen by the client. This method is called very early, before any ArchiveRow population, and can only rely on fields directly accessible in the Reader. On the other hand, that makes is reasonably cheap to skip rows.
If you implement this method, you MUST aslo implement RequiredPhaseOneFields() to tell the query rewriter about fields you need, otherwise they will not be present in the phase one query and you will crash.Declaration
protected override bool AcceptRow(SoDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader |
Returns
| Type | Description |
|---|---|
| bool | true if the current row should be further processed |
Overrides
PostProcessQuery()
This method is called after ModifyQuery has been called on all extenders, but before the query is executed. It is used for processing that needs the query to be 'complete' from the extenders, and gives the opportunity to tweak it, for instance by adding return fields needed for some particular functionality.
Declaration
public override void PostProcessQuery()Overrides
RequiredPhaseOneFields()
Return the FieldInfo fields needed by AcceptRow(SoDataReader), so that the query rewriter does not drop them. Implement this method IFF you implement AcceptRow.
Declaration
protected override FieldInfo[] RequiredPhaseOneFields()Returns
| Type | Description |
|---|---|
| FieldInfo[] |
Overrides
SetDesiredEntities(params string[])
Set the desired entities
Declaration
public override void SetDesiredEntities(params string[] entities)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | entities | Names of desired entities |