breeze-client / EntityAction

Class: EntityAction

Defined in: src/entity/entity-action.ts:7

EntityAction is an 'Enum' containing all of the valid actions that can occur to an 'Entity'.

Extends

• BreezeEnum

Constructors

Constructor

new EntityAction(propertiesObj?): EntityAction

Defined in: src/core/enum.ts:72

Creates a symbol, copying each property of propertiesObj onto it. Used to declare the symbols of an enum, as static members of its class; its name is set when the class calls BreezeEnum.resolveSymbols.

Parameters

propertiesObj?

Object

Returns

EntityAction

Inherited from

BreezeEnum.constructor

Properties

_$typeName

_$typeName: string

Defined in: src/core/enum.ts:60

Type of the enum; set in prototype of each enum

Inherited from

BreezeEnum._$typeName

---

name

name: string

Defined in: src/core/enum.ts:58

The name of this symbol

Inherited from

BreezeEnum.name

---

AcceptChanges

static AcceptChanges: EntityAction

Defined in: src/entity/entity-action.ts:33

AcceptChanges was called on the entity, or its entityState was set to Unmodified.

---

Attach

static Attach: EntityAction

Defined in: src/entity/entity-action.ts:10

Entity was attached via an AttachEntity call.

---

AttachOnImport

static AttachOnImport: EntityAction

Defined in: src/entity/entity-action.ts:14

Entity was attached as a result of an import.

---

AttachOnQuery

static AttachOnQuery: EntityAction

Defined in: src/entity/entity-action.ts:12

Entity was attached as a result of a query.

---

Clear

static Clear: EntityAction

Defined in: src/entity/entity-action.ts:38

The EntityManager was cleared. All entities detached.

---

Detach

static Detach: EntityAction

Defined in: src/entity/entity-action.ts:17

Entity was detached

---

EntityStateChange

static EntityStateChange: EntityAction

Defined in: src/entity/entity-action.ts:30

The EntityState of the entity was changed.

---

MergeOnImport

static MergeOnImport: EntityAction

Defined in: src/entity/entity-action.ts:22

Properties on the entity were merged as a result of an import.

---

MergeOnQuery

static MergeOnQuery: EntityAction

Defined in: src/entity/entity-action.ts:20

Properties on the entity were merged as a result of a query.

---

MergeOnSave

static MergeOnSave: EntityAction

Defined in: src/entity/entity-action.ts:24

Properties on the entity were merged as a result of a save

---

PropertyChange

static PropertyChange: EntityAction

Defined in: src/entity/entity-action.ts:27

A property on the entity was changed.

---

RejectChanges

static RejectChanges: EntityAction

Defined in: src/entity/entity-action.ts:35

RejectChanges was called on the entity.

Methods

isAttach()

isAttach(): boolean

Defined in: src/entity/entity-action.ts:47

Is this an 'attach' operation? ( Attach, AttachOnQuery or AttachOnImport)

Returns

boolean

---

isDetach()

isDetach(): boolean

Defined in: src/entity/entity-action.ts:51

Is this a 'detach' operation? ( Detach, Clear)

Returns

boolean

---

isModification()

isModification(): boolean

Defined in: src/entity/entity-action.ts:55

Is this a 'modification' operation? ( PropertyChange, MergeOnQuery, MergeOnSave, MergeOnImport, RejectChanges)

Returns

boolean

---

toJSON()

toJSON(): object

Defined in: src/core/enum.ts:180

Return enum name and symbol name

Returns

_$typeName

_$typeName: any

The name of the enum, such as "EntityState".

name

name: string

The name of the symbol, such as "Added".

Inherited from

BreezeEnum.toJSON

---

toString()

toString(): string

Defined in: src/core/enum.ts:175

Returns the string name of this Enum

Returns

string

Inherited from

BreezeEnum.toString

---

contains()

static contains(sym): boolean

Defined in: src/core/enum.ts:154

Returns whether an Enum contains a specified symbol.

let symbol = DayOfWeek.Friday;
if (DayOfWeek.contains(symbol)) {
    // do something
}

Parameters

sym

BreezeEnum

Object or symbol to test.

Returns

boolean

Whether this Enum contains the specified symbol.

Inherited from

BreezeEnum.contains

---

fromName()

static fromName(name): any

Defined in: src/core/enum.ts:113

Returns an Enum symbol given its name.

let dayOfWeek = DayOfWeek.from("Thursday");
// nowdayOfWeek === DayOfWeek.Thursday

Parameters

name

string

Name for which an enum symbol should be returned.

Returns

any

The symbol that matches the name or 'undefined' if not found.

Inherited from

BreezeEnum.fromName

---

getNames()

static getNames(): string[]

Defined in: src/core/enum.ts:100

Returns the names of all of the symbols contained within this Enum.

let symbols = DayOfWeek.getNames();

Returns

string[]

All of the names of the symbols contained within this Enum.

Inherited from

BreezeEnum.getNames

---

getSymbols()

static getSymbols<T>(this): InstanceType<T>[]

Defined in: src/core/enum.ts:86

Returns all of the symbols contained within this Enum.

let symbols = DayOfWeek.getSymbols();

Type Parameters

T

T extends typeof BreezeEnum

Parameters

this

T

Returns

InstanceType<T>[]

All of the symbols contained within this Enum.

Inherited from

BreezeEnum.getSymbols

---

resolveSymbols()

static resolveSymbols(): object[]

Defined in: src/core/enum.ts:124

Seals this enum so that no more symbols may be added to it. This should only be called after all symbols have already been added to the Enum. This method also sets the 'name' property on each of the symbols.

DayOfWeek.resolveSymbols();

Returns

Inherited from

BreezeEnum.resolveSymbols