Class EntityPublishHelper

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

Inheritance
Object
EntityPublishHelper
Inherited Members
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

Properties

EventDate

The time when the event starts

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

IsDeleted

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

IsDirty

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

IsMarkedForDelete

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

IsPublished

Is the row published?

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

IsSaving

Are the related enteties currently in a saving process.

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

PublishEnd

Time when the publishing starts

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

PublishStart

Time when the publishing starts

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

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

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.

OnRowLoaded()

Called by the entity when it has been loaded successfully.

Declaration
public void OnRowLoaded()

Explicit Interface Implementations

INestedPersist.IsDirty

Declaration
bool INestedPersist.IsDirty { get; }
Returns
Type Description
Boolean

INestedPersist.OnElementIdUpdate

Declaration
event OnIdUpdate INestedPersist.OnElementIdUpdate
Returns
Type Description
OnIdUpdate

INestedPersist.OnIdUpdate()

Declaration
void INestedPersist.OnIdUpdate()

INestedPersist.OnPreIdUpdate()

Declaration
void INestedPersist.OnPreIdUpdate()

INestedPersist.OnPrimaryKeyRequest(PKContainer)

Declaration
void INestedPersist.OnPrimaryKeyRequest(PKContainer pkContainer)
Parameters
Type Name Description
PKContainer pkContainer

INestedPersist.OnPrimaryKeyUpdate(PKContainer)

Declaration
void INestedPersist.OnPrimaryKeyUpdate(PKContainer pkContainer)
Parameters
Type Name Description
PKContainer pkContainer

INestedPersist.OnSave(BatchSave)

Declaration
void INestedPersist.OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

INestedPersist.OnSaved(Boolean)

Declaration
void INestedPersist.OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

INestedPersist.Save()

Declaration
void INestedPersist.Save()

INestedPersist.SetSaveOwner(INestedPersist)

Declaration
void INestedPersist.SetSaveOwner(INestedPersist saveOwner)
Parameters
Type Name Description
INestedPersist saveOwner

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)