Class EpSdkTask`Abstract`

Hierarchy

EpSdkTask

Constructors

constructor

new EpSdkTask(epSdkTask_Config: IEpSdkTask_Config): EpSdkTask
Parameters
- epSdkTask_Config: IEpSdkTask_Config
Returns EpSdkTask
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:147

Properties

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`Private` taskTransactionId

taskTransactionId: string

`Protected` `Optional` xContextId

xContextId?: string

Methods

`Protected` `Abstract` createFunc

createFunc(): Promise<IEpSdkTask_CreateFuncReturn>
Returns Promise<IEpSdkTask_CreateFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:184

`Private` createFuncCall

createFuncCall(): Promise<IEpSdkTask_CreateFuncReturn>
Returns Promise<IEpSdkTask_CreateFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:190

`Protected` createReturn4UpdateFunc

createReturn4UpdateFunc(__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}): IEpSdkTask_ExecuteReturn
Parameters
- __namedParameters: {
  epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
  }
  - epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn
Returns IEpSdkTask_ExecuteReturn
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:224

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

create_IEpSdkTask_IsUpdateRequiredFuncReturn(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkTask_IsUpdateRequiredFuncReturn
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkTask_IsUpdateRequiredFuncReturn
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:119

`Protected` deepCompareObjects

deepCompareObjects(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkDeepCompareResult
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkDeepCompareResult
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:106

`Protected` `Abstract` deleteFunc

deleteFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_DeleteFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_DeleteFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:211

`Private` deleteFuncCall

deleteFuncCall(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_DeleteFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_DeleteFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:218

execute

execute(xContextId?: string): Promise<IEpSdkTask_ExecuteReturn>
Parameters
- Optional xContextId: string
Returns Promise<IEpSdkTask_ExecuteReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:316

`Private` executeAbsent

executeAbsent(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_ExecuteReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_ExecuteReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:278

`Private` executePresent

executePresent(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_ExecuteReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_ExecuteReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:234

`Protected` getCreateFuncAction

getCreateFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:186

`Protected` `Abstract` getDefaultEpObjectKeys

getDefaultEpObjectKeys(): IEpSdkTask_EpObjectKeys
Returns IEpSdkTask_EpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:158

`Protected` getDeleteFuncAction

getDeleteFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:213

`Protected` `Abstract` getEpObjectKeys

getEpObjectKeys(epObject: any): IEpSdkTask_EpObjectKeys
Parameters
- epObject: any
Returns IEpSdkTask_EpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:160

`Protected` `Abstract` getFunc

getFunc(epSdkTask_Keys: IEpSdkTask_Keys): Promise<IEpSdkTask_GetFuncReturn>
Parameters
- epSdkTask_Keys: IEpSdkTask_Keys
Returns Promise<IEpSdkTask_GetFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:164

`Private` getFuncCall

getFuncCall(epSdkTask_Keys: IEpSdkTask_Keys): Promise<IEpSdkTask_GetFuncReturn>
Parameters
- epSdkTask_Keys: IEpSdkTask_Keys
Returns Promise<IEpSdkTask_GetFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:168

`Protected` `Abstract` getTaskKeys

getTaskKeys(): IEpSdkTask_Keys
Returns IEpSdkTask_Keys
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:162

`Protected` getUpdateFuncAction

getUpdateFuncAction(wouldFail?: boolean): EEpSdkTask_Action
Parameters
- wouldFail: boolean = false
Returns EEpSdkTask_Action
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:198

`Protected` initializeTask

initializeTask(): Promise<void>
Allows for async init of task

Returns Promise<void>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:308

`Protected` isCheckmode

isCheckmode(): boolean
Returns boolean
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:97

`Protected` `Abstract` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:174

`Private` isUpdateRequiredFuncCall

isUpdateRequiredFuncCall(__namedParameters: {
epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn;
}): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- __namedParameters: {
  epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn;
  }
  - epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:176

`Protected` prepareCompareObject4Output

prepareCompareObject4Output(obj: any): any
Parameters
- obj: any
Returns any
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:102

`Protected` transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkTask_Config: IEpSdkTask_Config): IEpSdkTask_Config
Parameters
- epSdkTask_Config: IEpSdkTask_Config
Returns IEpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:136

`Protected` truncate

truncate(str: string, maxLength: number): string
Parameters
- str: string
- maxLength: number
Returns string
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:140

`Protected` `Abstract` updateFunc

updateFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_UpdateFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_UpdateFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:196

`Private` updateFuncCall

updateFuncCall(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_UpdateFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_UpdateFuncReturn>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:205

`Protected` validateTaskConfig

validateTaskConfig(): Promise<void>
Returns Promise<void>
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:312