Class ImportDefinitionParameter
The server task parameters for the import definition processs
Inherits from the item server task parameter which records the id and label of the IImportDefinition this task should be run against
Inheritance
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
[DataContract]
public class ImportDefinitionParameter : ItemParameter, ICloneable, INotifyPropertyChanged
Constructors
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 |
---|---|
System.String |
Methods
AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask)
Returns false - the system should not automatically allow saving without changes
Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The import definition that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | False |
Overrides
Clone()
Declaration
public ImportDefinitionParameter Clone()
Returns
Type | Description |
---|---|
ImportDefinitionParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(ImportDefinitionParameter)
Declaration
public void CopyFromSource(ImportDefinitionParameter source)
Parameters
Type | Name | Description |
---|---|---|
ImportDefinitionParameter | source |
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
Type | Description |
---|---|
SerializedParam |
Overrides
DisplayUserParamOnSave(IHasSaveProcessingTask)
Returns false - the system should not automatically display the task parameters during save
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The import definition that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | 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 |
---|---|
System.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 |
---|---|
System.Boolean | False |