Class GetRecordAction

Generic action for retrieving entity records from the database. This action provides a flexible way to fetch records for any entity type by accepting the entity name and primary key values as parameters.

Example

// Get a single record by ID
await runAction({
  ActionName: 'Get Record',
  Params: [
    {
      Name: 'EntityName',
      Value: 'Customers'
    },
    {
      Name: 'PrimaryKey',
      Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
    }
  ]
});

// Get a record with composite primary key
await runAction({
  ActionName: 'Get Record',
  Params: [
    {
      Name: 'EntityName',
      Value: 'UserRoles'
    },
    {
      Name: 'PrimaryKey',
      Value: { 
        UserID: '123e4567-e89b-12d3-a456-426614174000',
        RoleID: '987f6543-e21b-12d3-a456-426614174000'
      }
    }
  ]
});

Hierarchy

BaseRecordMutationAction
- GetRecordAction

Index

Constructors

constructor

Methods

analyzeEntityError getEntityNameParam getEntityObject getFieldsParam getPrimaryKeyParam handleError InternalRunAction loadRecord Run setFieldValues

Constructors

constructor

new GetRecordAction(): GetRecordAction
Returns GetRecordAction
Inherited from BaseRecordMutationAction.constructor

Methods

`Protected`analyzeEntityError

analyzeEntityError(
    entity: BaseEntity,
    operation: "delete" | "create" | "update",
    entityName: string,
): ActionResultSimple
Analyze error from entity save/delete operation and return appropriate result
Parameters
- entity: BaseEntity
- operation: "delete" | "create" | "update"
- entityName: string
Returns ActionResultSimple
Inherited from BaseRecordMutationAction.analyzeEntityError
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:175

`Protected`getEntityNameParam

getEntityNameParam(
params: RunActionParams,
): { error?: ActionResultSimple; value?: string }
Extract and validate the EntityName parameter
Parameters
- params: RunActionParams
Returns { error?: ActionResultSimple; value?: string }
Inherited from BaseRecordMutationAction.getEntityNameParam
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:16

`Protected`getEntityObject

getEntityObject(
    entityName: string,
    contextUser: any,
    provider?: IMetadataProvider,
): Promise<
    { entity?: BaseEntity; entityInfo?: any; error?: ActionResultSimple },
>
Get entity metadata and create entity object
Parameters
- entityName: string
- contextUser: any
- Optionalprovider: IMetadataProvider
Returns Promise<{ entity?: BaseEntity; entityInfo?: any; error?: ActionResultSimple }>
Inherited from BaseRecordMutationAction.getEntityObject
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:73

`Protected`getFieldsParam

getFieldsParam(
params: RunActionParams,
): { error?: ActionResultSimple; value?: Record<string, any> }
Extract and validate the Fields parameter
Parameters
- params: RunActionParams
Returns { error?: ActionResultSimple; value?: Record<string, any> }
Inherited from BaseRecordMutationAction.getFieldsParam
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:54

`Protected`getPrimaryKeyParam

getPrimaryKeyParam(
params: RunActionParams,
): { error?: ActionResultSimple; value?: Record<string, any> }
Extract and validate the PrimaryKey parameter
Parameters
- params: RunActionParams
Returns { error?: ActionResultSimple; value?: Record<string, any> }
Inherited from BaseRecordMutationAction.getPrimaryKeyParam
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:35

`Protected`handleError

handleError(e: any, operation: string): ActionResultSimple
Handle generic errors with consistent formatting
Parameters
- e: any
- operation: string
Returns ActionResultSimple
Inherited from BaseRecordMutationAction.handleError
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:222

InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Retrieves a record for the specified entity type using its primary key.
Parameters
- params: RunActionParams
  The action parameters containing:
  
  EntityName (required): The name of the entity to retrieve
  
  PrimaryKey (required): Object containing primary key field(s) and value(s)
Returns Promise<ActionResultSimple>
ActionResultSimple with:
- Success: true if record was retrieved successfully
- ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED
- Message: Details about the operation
- Params: Output parameter 'Record' contains the retrieved entity data
Overrides BaseRecordMutationAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/crud/get-record.action.ts:62

`Protected`loadRecord

loadRecord(
    entity: BaseEntity,
    entityInfo: any,
    primaryKey: Record<string, any>,
    entityName: string,
): Promise<{ error?: ActionResultSimple; success: boolean }>
Load an existing record using primary key
Parameters
- entity: BaseEntity
- entityInfo: any
- primaryKey: Record<string, any>
- entityName: string
Returns Promise<{ error?: ActionResultSimple; success: boolean }>
Inherited from BaseRecordMutationAction.loadRecord
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:108

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseRecordMutationAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37

`Protected`setFieldValues

setFieldValues(
    entity: BaseEntity,
    fields: Record<string, any>,
    entityName: string,
): void
Set field values on an entity
Parameters
- entity: BaseEntity
- fields: Record<string, any>
- entityName: string
Returns void
Inherited from BaseRecordMutationAction.setFieldValues
- Defined in Actions/CoreActions/src/custom/crud/base-record-mutation.action.ts:162

Class GetRecordAction

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns GetRecordAction

Methods

ProtectedanalyzeEntityError

Parameters

Returns ActionResultSimple

ProtectedgetEntityNameParam

Parameters

Returns { error?: ActionResultSimple; value?: string }

ProtectedgetEntityObject

Parameters

Returns Promise<{ entity?: BaseEntity; entityInfo?: any; error?: ActionResultSimple }>

ProtectedgetFieldsParam

Parameters

Returns { error?: ActionResultSimple; value?: Record<string, any> }

ProtectedgetPrimaryKeyParam

Parameters

Returns { error?: ActionResultSimple; value?: Record<string, any> }

ProtectedhandleError

Parameters

Returns ActionResultSimple

InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedloadRecord

Parameters

Returns Promise<{ error?: ActionResultSimple; success: boolean }>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedsetFieldValues

Parameters

Returns void

Settings

On This Page

`Protected`analyzeEntityError

`Protected`getEntityNameParam

`Protected`getEntityObject

`Protected`getFieldsParam

`Protected`getPrimaryKeyParam

`Protected`handleError

`Protected`loadRecord

`Protected`setFieldValues