Class UpdateRecordAction

Generic action for updating existing entity records in the database. This action provides a flexible way to update records for any entity type by accepting the entity name, primary key, and field values as parameters.

Example

// Update a customer record
await runAction({
  ActionName: 'Update Record',
  Params: [
    {
      Name: 'EntityName',
      Value: 'Customers'
    },
    {
      Name: 'PrimaryKey',
      Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
    },
    {
      Name: 'Fields',
      Value: {
        Email: 'newemail@example.com',
        Status: 'Inactive',
        UpdatedAt: new Date()
      }
    }
  ]
});

Hierarchy

BaseRecordMutationAction
- UpdateRecordAction

Index

Constructors

constructor

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

Properties

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

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>
Updates an existing record for the specified entity type.
Parameters
- params: RunActionParams
  The action parameters containing:
  
  EntityName (required): The name of the entity to update
  
  PrimaryKey (required): Object containing primary key field(s) and value(s)
  
  Fields (required): Object containing field names and values to update
Returns Promise<ActionResultSimple>
ActionResultSimple with:
- Success: true if record was updated successfully
- ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED, NO_CHANGES, CONCURRENT_UPDATE
- Message: Details about the operation
- Params: Output parameter 'UpdatedFields' contains the fields that were actually changed
Overrides BaseRecordMutationAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/crud/update-record.action.ts:55

`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:49

`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 UpdateRecordAction

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns UpdateRecordAction

Properties

Static ReadonlyAuthorizesCaller

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

`Static` `Readonly`AuthorizesCaller

`Protected`analyzeEntityError

`Protected`getEntityNameParam

`Protected`getEntityObject

`Protected`getFieldsParam

`Protected`getPrimaryKeyParam

`Protected`handleError

`Protected`loadRecord

`Protected`setFieldValues