Class RestrictionReporterStorage

Inheritance
object
RestrictionStorageBase
RestrictionReporterStorage
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[RestrictionStoragePlugin("Reporter")]
public class RestrictionReporterStorage : RestrictionStorageBase, IRestrictionStorage

Constructors

RestrictionReporterStorage()

Declaration
public RestrictionReporterStorage()

Fields

SaintActivityType

Declaration
public const string SaintActivityType = "saintActivityType"
Field Value
Type Description
string

SaintAmountClass

Declaration
public const string SaintAmountClass = "saintAmountClass"
Field Value
Type Description
string

SaintDirection

Declaration
public const string SaintDirection = "saintDirection"
Field Value
Type Description
string

SaintIntention

Declaration
public const string SaintIntention = "saintIntention"
Field Value
Type Description
string

SaintSaleStatus

Declaration
public const string SaintSaleStatus = "saintSaleStatus"
Field Value
Type Description
string

SaintTicketCategory

Declaration
public const string SaintTicketCategory = "saintTicketCategory"
Field Value
Type Description
string

SaintTicketStatus

Declaration
public const string SaintTicketStatus = "saintTicketStatus"
Field Value
Type Description
string

StorageType

Declaration
public const string StorageType = "Reporter"
Field Value
Type Description
string

Methods

FormatGetRestrictionValues(ArchiveRestrictionInfo[])

Declaration
public void FormatGetRestrictionValues(ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions

FormatSaveRestrictionValues(ArchiveRestrictionInfo[])

Declaration
public void FormatSaveRestrictionValues(ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions

GetHandledColumns(string)

Get the names of all columns handled for the given combination of provider name and storage type. These are the only valid column names for the other methods in this interface.

Declaration
public override string[] GetHandledColumns(string providerName)
Parameters
Type Name Description
string providerName

Provider name to check for
Returns
Type Description
string[]

Array of column names. This array may be empty if no columns are handled.
Overrides
Exceptions
Type Condition
SoIllegalOperationException

Thrown if there is no handler for the given storageType.

GetRestrictions(string, string)

Retrieve previously saved restrictions according to the given keys The ArchiveRestrictionInfo objects are fully populated, including the ArchiveColumnInfo part.

Declaration
public override ArchiveRestrictionInfo[] GetRestrictions(string providerName, string storageKey)
Parameters
Type Name Description
string providerName

Name of archive list provider who owns/supplies/processes the columns
string storageKey

Key information to pass to storage handler. In this handler we expect the format to be "report=45" or some other relevant key
Returns
Type Description
ArchiveRestrictionInfo[]

Array of restrictions. This array may be empty if no restrictions corresponded to the given key.
Overrides

GetSpecifiedRestrictionsWithDefaults(string, string, params string[])

Retrieve previously saved restrictions, returning exactly those columns that have been specified. If the columns have valid saved values, those will be returned; otherwise, default values for operator and value will be created. The ArchiveRestrictionInfo objects are fully populated, including the ArchiveColumnInfo part.

Declaration
public override ArchiveRestrictionInfo[] GetSpecifiedRestrictionsWithDefaults(string providerName, string storageKey, params string[] requestedRestrictions)
Parameters
Type Name Description
string providerName

Name of archive list provider who owns/supplies/processes the columns
string storageKey

Key information to pass to storage handler. In this handler we expect the format to be "report=45" or some other relevant key
string[] requestedRestrictions
Returns
Type Description
ArchiveRestrictionInfo[]

Array of restrictions. This array may be empty if no restrictions corresponded to the given key.
Overrides
Exceptions
Type Condition
SoIllegalOperationException

Thrown if there is no handler for the given storageType.

SaveRestrictions(string, string, params ArchiveRestrictionInfo[])

Save an array of restrictions for later use. The ColumnInfo member of the archive restriction info objects is not used and can be null.

Declaration
public override void SaveRestrictions(string providerName, string storageKey, params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
string providerName

Name of archive list provider who owns/supplies/processes the columns
string storageKey

Key information to pass to storage handler. In this handler we expect the format to be "report=45" or some other relevant key
ArchiveRestrictionInfo[] restrictions

Array of restrictions to be saved. Values, operators etc are also saved.
Overrides

Implements

Extension Methods