Class CodeSnippetExecutorParameters
The server task parameters for executing a code snippet on the service
Inherits from the item server task parameter which records the id and label of the BaseObjectType this task should be calculated against
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
public class CodeSnippetExecutorParameters : ItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<CodeSnippetExecutorParameters>Constructors
CodeSnippetExecutorParameters()
Creates a new code snippet server task process parameter
Declaration
public CodeSnippetExecutorParameters()CodeSnippetExecutorParameters(IBaseEntity)
Creates a new code snippet type server task process parameter for the specified code snippet
Declaration
public CodeSnippetExecutorParameters(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item |
Fields
UNIQUE_TASK_ID
The unique id of the code snippet server task
Declaration
public const string UNIQUE_TASK_ID = "6E1B2CEB-AE3B-41CC-A9AC-CDC4812808F4"Field Value
| Type | Description |
|---|---|
| string |
Properties
FormulaContext
Declaration
public IFormulaFunctionsWithContext FormulaContext { get; set; }Property Value
| Type | Description |
|---|---|
| IFormulaFunctionsWithContext |
ServerTaskMode
Declaration
public bool ServerTaskMode { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
SnippetParams
Declaration
public string SnippetParams { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
Clone()
Creates a new instance of this class (of type CodeSnippetExecutorParameters) with all the same property values as this instance
Declaration
public CodeSnippetExecutorParameters Clone()Returns
| Type | Description |
|---|---|
| CodeSnippetExecutorParameters | A new instance of this class with all the same property values as this instance |
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(CodeSnippetExecutorParameters)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(CodeSnippetExecutorParameters source)Parameters
| Type | Name | Description |
|---|---|---|
| CodeSnippetExecutorParameters | source | The source object to copy all values from. |
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
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns that this is a base entity type recalculation task against the specified blended transaction
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the object entity type |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is a object entity type recalculation task |