Interface PoiRepositoryInterface

The PoiRepository retrieves POIs from the database through the REST API.

A full list of POIs can be fetched by calling findAll and a specific POI by calling findOne.

interface PoiRepositoryInterface {
    create(): PoiInterface;
    createFilterBuilder(): PoiFilterInterface;
    filter(params): Promise<PoiInterface[]>;
    findAll(forceFetch?): Promise<PoiInterface[]>;
    findOne(id, forceFetch?): Promise<PoiInterface>;
    remove(item): Promise<void>;
    save(items): Promise<PoiInterface[]>;
}

Hierarchy (view full)

RestRepositoryInterface<PoiInterface>
- PoiRepositoryInterface

Index

Methods

create createFilterBuilder filter findAll findOne remove save

Methods

create

create(): PoiInterface
Factory method. Creates and returns a new empty instance of the entity.

Returns PoiInterface
An instance of the entity.

Inherited from RestRepositoryInterface.create

createFilterBuilder

createFilterBuilder(): PoiFilterInterface
Generates a PoiFilterInterface object that is used for building data fetch queries.

Returns PoiFilterInterface

filter

filter(params): Promise<PoiInterface[]>
Find all repository items matching the filter parameters.
Parameters
- params: RestFilterInterface
  Filter parameters. Use .FilterInterface to create them.
Returns Promise<PoiInterface[]>
Promise with the entities that match the filter.

Inherited from RestRepositoryInterface.filter

findAll

findAll(forceFetch?): Promise<PoiInterface[]>
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
  Whether to bypass the cache and retrieve a fresh copy from the server.
Returns Promise<PoiInterface[]>
Promise with the repository items.

Inherited from RestRepositoryInterface.findAll

findOne

findOne(id, forceFetch?): Promise<PoiInterface>
Get one repository item by id. The cached data will be returned if the data has been fetched before. Use the forceFetch parameter to retrieve a fresh copy from the server. In case a new record is fetched, the data and dataMap will be updated accordingly.
Parameters
- id: number
  Identifier of the repository item
- Optional forceFetch: boolean
  Whether to bypass the cache and retrieve a fresh copy from the server.
Returns Promise<PoiInterface>
Inherited from RestRepositoryInterface.findOne

remove

remove(item): Promise<void>
Deletes an item from the repository.
Parameters
- item: PoiInterface
  The item to delete.
Returns Promise<void>
Promise that resolves once the request has completed.

Inherited from RestRepositoryInterface.remove

save

save(items): Promise<PoiInterface[]>
Saves new and/or updated items.
Parameters
- items: PoiInterface | PoiInterface[]
  The item(s) to save or update.
Returns Promise<PoiInterface[]>
Promise with the saved objects.

Inherited from RestRepositoryInterface.save

Generated using TypeDoc