breeze-client / EntityState

Class: EntityState

Defined in: src/entity/entity-state.ts:6

EntityState is an 'Enum' containing all of the valid states for an 'Entity'.

Extends

• BreezeEnum

Constructors

Constructor

new EntityState(propertiesObj?): EntityState

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

EntityState

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

---

Added

static Added: EntityState

Defined in: src/entity/entity-state.ts:11

The 'Added' state.

---

Deleted

static Deleted: EntityState

Defined in: src/entity/entity-state.ts:15

The 'Deleted' state.

---

Detached

static Detached: EntityState

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

The 'Detached' state.

---

Modified

static Modified: EntityState

Defined in: src/entity/entity-state.ts:13

The 'Modified' state.

---

Unchanged

static Unchanged: EntityState

Defined in: src/entity/entity-state.ts:9

The 'Unchanged' state.

Methods

isAdded()

isAdded(): boolean

Defined in: src/entity/entity-state.ts:48

Return whether an entityState instance is EntityState.Added.

var es = anEntity.entityAspect.entityState;
return es.isAdded();

is the same as

return es === EntityState.Added;

Returns

boolean

---

isAddedModifiedOrDeleted()

isAddedModifiedOrDeleted(): boolean

Defined in: src/entity/entity-state.ts:138

Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.

var es = anEntity.entityAspect.entityState;
return es.isAddedModifiedOrDeleted();

is the same as

return es === EntityState.Added || es === EntityState.Modified || es === EntityState.Deleted

Returns

boolean

---

isAddedOrModified()

isAddedOrModified(): boolean

Defined in: src/entity/entity-state.ts:123

Return true if EntityStatis is Added or Modified

Returns

boolean

---

isDeleted()

isDeleted(): boolean

Defined in: src/entity/entity-state.ts:81

Returns whether an entityState instance is EntityState.Deleted.

var es = anEntity.entityAspect.entityState;
return es.isDeleted();

is the same as

return es === EntityState.Deleted;

Returns

boolean

---

isDeletedOrDetached()

isDeletedOrDetached(): boolean

Defined in: src/entity/entity-state.ts:102

Return true if EntityState is Deleted or Detached

Returns

boolean

---

isDetached()

isDetached(): boolean

Defined in: src/entity/entity-state.ts:97

Returns whether an entityState instance is EntityState.Detached.

var es = anEntity.entityAspect.entityState;
return es.isDetached();

is the same as

return es === EntityState.Detached;

Returns

boolean

---

isModified()

isModified(): boolean

Defined in: src/entity/entity-state.ts:64

Returns whether an entityState instance is EntityState.Modified.

var es = anEntity.entityAspect.entityState;
return es.isModified();

is the same as

return es === EntityState.Modified;

Returns

boolean

---

isUnchanged()

isUnchanged(): boolean

Defined in: src/entity/entity-state.ts:31

Returns whether an entityState instance is EntityState.Unchanged.

var es = anEntity.entityAspect.entityState;
return es.isUnchanged();

is the same as

return es === EntityState.Unchanged;

Returns

boolean

---

isUnchangedOrModified()

isUnchangedOrModified(): boolean

Defined in: src/entity/entity-state.ts:118

Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.

var es = anEntity.entityAspect.entityState;
return es.isUnchangedOrModified();

is the same as

return es === EntityState.Unchanged || es === EntityState.Modified

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