Class ProcessingStatusDTO

description: A DTO class that consists of a status property only and can be used to determine the state of processing individual entities, i.e. to determine whether an entity was processed before.
since: v0.3.2

Hierarchy

BaseDTO
- ProcessingStatusDTO

Index

Constructors

constructor

Properties

status

Methods

create

Constructors

constructor

new ProcessingStatusDTO(data?: any): ProcessingStatusDTO

Inherited from BaseDTO.constructor
- Defined in src/common/models/BaseDTO.ts:28
Constructs an instance of this DTO.

Parameters
- data: any = {}
Returns ProcessingStatusDTO

Properties

status

status: ProcessingState

Contains the status of processing of an entity. This property may contain one of the following values as listed in ProcessingState.

example: 1 or 0 or -1
access: public
var: {number}

Methods

Static create

create(code: number): ProcessingStatusDTO

- Defined in src/users/models/ProcessingStatusDTO.ts:62
Creates an object instance of this DTO.

access
public

static
Parameters
- code: number
  
  The status code as defined by ProcessingState
Returns ProcessingStatusDTO
The created instance of this class, with provided code.

Generated using TypeDoc