Class ReportStorage
- Namespace
- Geotab.Checkmate.ObjectModel
- Assembly
- Geotab.Checkmate.ObjectModel.dll
Stores the binary data for a generate excel report.
public class ReportStorage : EntityWithVersion, IEntity, IComparable, IIdentifiable, IVersion- Inheritance
-
ReportStorage
- Implements
- Inherited Members
Constructors
ReportStorage()
public ReportStorage()Properties
BinaryData
Gets or sets the excel binary data.
public byte[]? BinaryData { get; set; }Property Value
- byte[]
The Excel binary data.
CreationDate
Gets or sets a DateTime of when the report was generated.
public DateTime? CreationDate { get; set; }Property Value
- DateTime?
The timestamp of when the report was generated.
DashboardInstance
Gets or sets the dashboard instance of the drop down report request.
public object? DashboardInstance { get; set; }Property Value
- object
The report arguments.
Expiry
Gets or sets the expiry date of the report in the storage.
public DateTime? Expiry { get; set; }Property Value
- DateTime?
The expiry date time of the report.
LastUpdated
Gets or sets the datetime when the report was known to be processing or finished processing. This property is updated periodically like a heart beat when a report is getting processed by the service.
public DateTime? LastUpdated { get; set; }Property Value
- DateTime?
The last update datetime of the report.
ProcessingStartDate
Gets or sets a DateTime of when the report started processing.
public DateTime? ProcessingStartDate { get; set; }Property Value
- DateTime?
The timestamp of when the report started processing, or null if the processing hasn't started yet.
ReportDateRange
Gets or sets the reports date range.
public DateRange? ReportDateRange { get; set; }Property Value
- DateRange
The report's date range.
ReportName
Gets or sets the name of the report.
public string? ReportName { get; set; }Property Value
- string
The name of the report.
ReportSource
Gets or sets the source of the report whether it's dropdown or email ReportDestination.
public ReportDestination? ReportSource { get; set; }Property Value
- ReportDestination?
The report source.
ReportType
Gets or sets the type of the report whether it's pdf or excel.
public string? ReportType { get; set; }Property Value
- string
The type of the report.
Size
Gets or sets the size (bytes) of the report.
public long? Size { get; set; }Property Value
- long?
The report size in bytes.
Status
Gets or sets the current status of the report which is being prepared, completed or failed ReportProcessingStatus.
public ReportProcessingStatus? Status { get; set; }Property Value
- ReportProcessingStatus?
The current report status.
Methods
Clone()
Creates a new object that is a copy of the current instance.
public override IEntity Clone()Returns
- IEntity
A new object that is a copy of this instance.
GetStorageFileName()
Gets an unique filename (including the extension) for storage purpose.
public string GetStorageFileName()Returns
- string
An unique filename with appropriate extension.
Exceptions
- ArgumentException
Throws ArgumentException if the Id or the ReportType is not set.
IsReadyToSave()
Check if the report is ready to be saved.
public bool IsReadyToSave()Returns
- bool
true if ReportProcessingStatus is successful or ExcelServerError.