import AdministrativeStateSearchBuilder from 'opengate-js/src/searching/builder/AdministrativeStateSearchBuilder.js'

public class | source

AdministrativeStateSearchBuilder

SearchBuilder → AdministrativeStateSearchBuilder

Defined a search over operational status catalogs

ogapi.administrativeStateSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Public Members
public	customFilters: {}

Public Methods
public	build(): StaticSearch Build a instance of StaticSearch
public	withEntityType(entityType: string): AdministrativeStateSearchBuilder Set entityType to search
public	withId(administrativeStateId: string): AdministrativeStateSearchBuilder Sets id to search

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

Constructor

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

Build a instance of StaticSearch

Throw error on url build

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

Set entityType to search

Name	Type	Attribute	Description
entityType	string	nullable: false	model name

throw error when entityType is not typeof string

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

Sets id to search

Name	Type	Attribute	Description
administrativeStateId	string	nullable: false	specific type id

throw error when hardwareId is not typeof string

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