Show / Hide Table of Contents

Class EntityPublishHelper

Helper class used by the entities for dealing with the publish state of a record.

Inheritance
object
EntityPublishHelper
Implements
ITableRowLoadHandler
INestedPersist
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public sealed class EntityPublishHelper : ITableRowLoadHandler, INestedPersist
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

Constructors

EntityPublishHelper(PublishTableInfo, EntityBase, TableRowBase)

Default constructor used by the entities.

Declaration
public EntityPublishHelper(PublishTableInfo publishTableInfo, EntityBase entity, TableRowBase mainRow)
Parameters
Type Name Description
PublishTableInfo publishTableInfo

The instance of the PublishTableInfo that the publish helper should use for fetching data.

EntityBase entity

The entity using the publish helper.

TableRowBase mainRow

The row that can be published

Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

Properties

EventDate

The time when the event starts

Declaration
public DateTime EventDate { get; set; }
Property Value
Type Description
DateTime
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

IsDeleted

Gets a value indicating whether this instance is deleted.

Declaration
public bool IsDeleted { get; }
Property Value
Type Description
bool

true if this instance is deleted; otherwise, false.

Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

IsDirty

Helper class used by the entities for dealing with the publish state of a record.

Declaration
public bool IsDirty { get; }
Property Value
Type Description
bool
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

IsMarkedForDelete

Gets or sets a value indicating whether this instance is marked for delete.

Declaration
public bool IsMarkedForDelete { get; set; }
Property Value
Type Description
bool

true if this instance is marked for delete; otherwise, false.

Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

IsPublished

Is the row published?

Declaration
public bool IsPublished { get; set; }
Property Value
Type Description
bool
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

IsSaving

Are the related enteties currently in a saving process.

Declaration
public bool IsSaving { get; }
Property Value
Type Description
bool
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

PublishEnd

Time when the publishing starts

Declaration
public DateTime PublishEnd { get; set; }
Property Value
Type Description
DateTime
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

PublishStart

Time when the publishing starts

Declaration
public DateTime PublishStart { get; set; }
Property Value
Type Description
DateTime
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

Methods

ModifyQuery(IdxBase)

Modfy a query by outer joining with the publishe record and adding all the fields in the publish table to the list of return fields. The PublishTableInfo is returned for the purpos of being passed to the constructor.

Declaration
public static PublishTableInfo ModifyQuery(IdxBase query)
Parameters
Type Name Description
IdxBase query
Returns
Type Description
PublishTableInfo
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

OnRowLoad(SoDataReader, TableRowBase)

Called by the entity when it is loaded from the database so the underlying PublishRow object can be fetched.

Declaration
public void OnRowLoad(SoDataReader reader, TableRowBase row)
Parameters
Type Name Description
SoDataReader reader

Reader to read publish information from

TableRowBase row

The main row of the query.

Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

OnRowLoaded()

Called by the entity when it has been loaded successfully.

Declaration
public void OnRowLoaded()
Remarks

The query can be modified using the ModifyQuery(IdxBase) method. The returned PublishTableInfo should be used when instanciating the publish helper.

Implements

ITableRowLoadHandler
INestedPersist

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top