Interface ImageRepositoryInterface

The RestRepository retreives resources from the database through the REST API.

A full list of resources can be fetched by calling findAll and a specific resource by calling findOne.

interface ImageRepositoryInterface {
    create(): ImageInterface;
    createFilterBuilder(): ImageFilterInterface;
    filter(params: RestFilterInterface): Promise<ImageInterface[]>;
    findAll(forceFetch?: boolean): Promise<ImageInterface[]>;
    findOne(id: number, forceFetch?: boolean): Promise<ImageInterface>;
    remove(item: ImageInterface): Promise<void>;
    save(items: ImageInterface | ImageInterface[]): Promise<ImageInterface[]>;
}

Hierarchy (View Summary)

RestRepositoryInterface<ImageInterface>
- ImageRepositoryInterface

Index

Methods

create createFilterBuilder filter findAll findOne remove save

Methods

create

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

Returns ImageInterface
An instance of the entity.

Inherited from RestRepositoryInterface.create

createFilterBuilder

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

Returns ImageFilterInterface

filter

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

Inherited from RestRepositoryInterface.filter

findAll

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

Inherited from RestRepositoryInterface.findAll

findOne

findOne(id: number, forceFetch?: boolean): Promise<ImageInterface>
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
- OptionalforceFetch: boolean
  Whether to bypass the cache and retrieve a fresh copy from the server.
Returns Promise<ImageInterface>
Inherited from RestRepositoryInterface.findOne

remove

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

Inherited from RestRepositoryInterface.remove

save

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

Inherited from RestRepositoryInterface.save