Administrative State Search Builder

AdministrativeStateSearchBuilder

AdministrativeStateSearchBuilder Objects

class AdministrativeStateSearchBuilder()

Defined a search over operational status catalogs

constructor

function constructor()

Arguments:

• parent InternalOpenGateAPI - Instance of our InternalOpenGateAPI

build

function build() -> 'StaticSearch'

Build a instance of StaticSearch

Returns:

• StaticSearch

Example:

  ogapi.administrativeStateSearchBuilder().filter({and:[]}).build()

customFilters

function customFilters()

withEntityType

function withEntityType(entityType: string) -> 'AdministrativeStateSearchBuilder'

Set entityType to search

Arguments:

• entityType string - model name

Returns:

• AdministrativeStateSearchBuilder

Example:

 ogapi.administrativeStateSearchBuilder().withEntityType('myEntityType').build()

withId

function withId(administrativeStateId: string) -> 'AdministrativeStateSearchBuilder'

Sets id to search

Arguments:

• administrativeStateId string - specific type id

Returns:

• AdministrativeStateSearchBuilder

Example:

 ogapi.administrativeStateSearchBuilder().withId('myId').build()