Class EntityPublishHelper
Helper class used by the entities for dealing with the publish state of a record.
Inheritance
System.Object
EntityPublishHelper
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: SoDataBase.dll
Syntax
public sealed class EntityPublishHelper : ITableRowLoadHandler, INestedPersist
Constructors
EntityPublishHelper(PublishTableInfo, EntityBase, TableRowBase)
Default constructor used by the entities.
Declaration
public EntityPublishHelper(PublishTableInfo publishTableInfo, EntityBase entity, TableRowBase mainRow)
Parameters
Properties
EventDate
The time when the event starts
Declaration
public DateTime EventDate { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
IsDeleted
Declaration
public bool IsDeleted { get; }
Property Value
IsDirty
Declaration
public bool IsDirty { get; }
Property Value
IsMarkedForDelete
Declaration
public bool IsMarkedForDelete { get; set; }
Property Value
IsPublished
Declaration
public bool IsPublished { get; set; }
Property Value
IsSaving
Are the related enteties currently in a saving process.
Declaration
public bool IsSaving { get; }
Property Value
PublishEnd
Time when the publishing starts
Declaration
public DateTime PublishEnd { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
PublishStart
Time when the publishing starts
Declaration
public DateTime PublishStart { get; set; }
Property Value
Type |
Description |
System.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
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
INestedPersist.OnElementIdUpdate
Declaration
event OnIdUpdate INestedPersist.OnElementIdUpdate
Returns
INestedPersist.OnIdUpdate()
Declaration
void INestedPersist.OnIdUpdate()
INestedPersist.OnPreIdUpdate()
Declaration
void INestedPersist.OnPreIdUpdate()
INestedPersist.OnPrimaryKeyRequest(PKContainer)
Declaration
void INestedPersist.OnPrimaryKeyRequest(PKContainer pkContainer)
Parameters
INestedPersist.OnPrimaryKeyUpdate(PKContainer)
Declaration
void INestedPersist.OnPrimaryKeyUpdate(PKContainer pkContainer)
Parameters
INestedPersist.OnSave(BatchSave)
Declaration
void INestedPersist.OnSave(BatchSave batchSave)
Parameters
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
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)