Class ImportDefinitionParameter
The server task parameters for the import definition process
Inherits from the item server task parameter which records the id and label of the IImportDefinition this task should be run against
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
public class ImportDefinitionParameter : ItemParameter, ICloneable, INotifyPropertyChangedConstructors
ImportDefinitionParameter()
Creates a new import definition server task process parameter
Declaration
public ImportDefinitionParameter()ImportDefinitionParameter(IImportDefinition)
Creates a new import definition server task process parameter for the specified import definition
Declaration
public ImportDefinitionParameter(IImportDefinition item)Parameters
| Type | Name | Description |
|---|---|---|
| IImportDefinition | item | An IImportDefinition this parameter will make the task run against |
Fields
UNIQUE_TASK_ID
The unique id of the import definition calculation server task
Declaration
public const string UNIQUE_TASK_ID = "6CB8D870-AF80-40F4-AC31-46DF25F37CD7"Field Value
| Type | Description |
|---|---|
| string |
Methods
AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask, IEntityUpdater)
Returns false - the system should not automatically allow saving without changes
Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The import definition that has been modified |
| IEntityUpdater | context | The current context that it has been modified within |
Returns
| Type | Description |
|---|---|
| bool | False |
Overrides
Clone()
Declaration
public ImportDefinitionParameter Clone()Returns
| Type | Description |
|---|---|
| ImportDefinitionParameter |
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(ImportDefinitionParameter)
Declaration
public void CopyFromSource(ImportDefinitionParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| ImportDefinitionParameter | 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)
Returns false - the system should not automatically display the task parameters during save
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The import definition that has been modified |
| IEntityUpdater | context | The current context that it has been modified within |
Returns
| Type | Description |
|---|---|
| bool | False |
Overrides
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns that this is an import definition task against the specified import definition
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the import definition |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is an import definition task against the specified import definition |
Overrides
ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)
Returns false - the system should not automaically create a task when modifying import definitions
Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The import definition that has been modified |
| IEntityUpdater | context | The current context that it has been modified within |
Returns
| Type | Description |
|---|---|
| bool | False |