Interface SiteRepositoryInterface

Hierarchy

RestRepositoryInterface<SiteInterface>
- SiteRepositoryInterface

Index

Methods

Methods

create

create(): SiteInterface

Inherited from RestRepositoryInterface.create

Factory method. Creates and returns a new empty instance of the entity.

Returns SiteInterface

filter

filter(params: RestFilterInterface): Promise<SiteInterface[]>

Inherited from RestRepositoryInterface.filter

Find all repository items matching the filter parameters.

Parameters
- params: RestFilterInterface
Returns Promise<SiteInterface[]>

findAll

findAll(forceFetch?: boolean): Promise<SiteInterface[]>

Inherited from RestRepositoryInterface.findAll

Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

Parameters
- Optional forceFetch: boolean
  
  Flag whether to force a server request or not. False by default.
Returns Promise<SiteInterface[]>
Array of resources.

findByLocation

findByLocation(location: Vector3): Promise<SiteInterface>

Returns the site that is closest to the specified global coordinate.

Parameters
- location: Vector3
  
  Location of the site in WGS 84
Returns Promise<SiteInterface>
Promise that resolves with the site

findOne

findOne(id: number, forceFetch?: boolean): Promise<SiteInterface>

Inherited from RestRepositoryInterface.findOne

Gets one repository item by id. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server. In case a new record is fetched, the data will be updated accordingly.

Parameters
- id: number
- Optional forceFetch: boolean
  
  False by default.
Returns Promise<SiteInterface>

remove

remove(item: SiteInterface): Promise<void>

Inherited from RestRepositoryInterface.remove

Deletes an item from the repository.

Parameters
- item: SiteInterface
Returns Promise<void>

save

save(resources: SiteInterface | SiteInterface[]): Promise<SiteInterface[]>

Inherited from RestRepositoryInterface.save

Saves new and/or updated items.

Parameters
- resources: SiteInterface | SiteInterface[]
  
  The resource or array of resources to save or update.
Returns Promise<SiteInterface[]>
A new array with referenced resources.

Generated using TypeDoc