Class CustomObjectSaveParameter

The server task parameters for the custom object calculation process

Inherits from the item server task parameter which records the id and label of the ICustomObject that was modified

Commits any changes in the custom object to the database schema. Can only be done if the object is marked as LoadDynamically.
Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
CustomObjectSaveParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Commit Custom Object To Database", "1B7A8C35-2B17-453D-A422-1A3193679332", DefaultForHasSaveProcessingTask = typeof(ICustomObject), Description = "Commits any changes in the custom object to the database schema. Can only be done if the object is marked as LoadDynamically.")]
public class CustomObjectSaveParameter : ItemParameter, ICloneable, INotifyPropertyChanged

Constructors

CustomObjectSaveParameter()

Creates a new custom object server task process parameter

Declaration
public CustomObjectSaveParameter()

CustomObjectSaveParameter(ICustomObject)

Creates a new custom object server task process parameter for the specified custom object

Declaration
public CustomObjectSaveParameter(ICustomObject item)
Parameters
Type Name Description
ICustomObject item

An ICustomObject this parameter will make the task run against

Fields

UNIQUE_TASK_ID

The unique id of the custom object server task

Declaration
public const string UNIQUE_TASK_ID = "1B7A8C35-2B17-453D-A422-1A3193679332"
Field Value
Type Description
string

Properties

CommitToDatabase

Indicates this custom object should have all changes committed to the database

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

Methods

AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask, IEntityUpdater)

Should ony automatically allow saving without changes if the custom object is marked as LoadDynamically

Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The custom object that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

True if the custom object is marked as LoadDynamically
Overrides

Clone()

Declaration
public CustomObjectSaveParameter Clone()
Returns
Type Description
CustomObjectSaveParameter

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(CustomObjectSaveParameter)

Declaration
public void CopyFromSource(CustomObjectSaveParameter source)
Parameters
Type Name Description
CustomObjectSaveParameter source

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

DisplayUserParamOnSave(IHasSaveProcessingTask, IEntityUpdater)

Should ony automatically display the task parameters during save if the custom object is marked as LoadDynamically

Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The custom object that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

True if the custom object is marked as LoadDynamically
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a custom object save recalculation task against the custom object

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing the custom object to the database
Returns
Type Description
string

A string stating that this is a custom object save recalculation task against the custom object
Overrides

ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)

Should ony automatically create a task if the custom object is marked as LoadDynamically

Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The custom object that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

True if the custom object is marked as LoadDynamically
Overrides

Implements

Extension Methods