@sap-cloud-sdk/core
Version:
SAP Cloud SDK for JavaScript core
41 lines • 1.77 kB
TypeScript
import { Entity } from '../entity';
import { Filterable, FilterLink } from '../filter';
import { Orderable } from '../order';
import { Link } from './link';
/**
* Represents a one to many relation for OData v4 entities.
* For OData v2 entities the [[Link]] is used to represent one to many relation.
* See [[Link]] for more information.
*/
export declare class OneToManyLink<EntityT extends Entity, LinkedEntityT extends Entity> extends Link<EntityT, LinkedEntityT> {
_filters: FilterLink<EntityT, LinkedEntityT>;
_orderBy: Orderable<LinkedEntityT>[];
_top: number;
_skip: number;
clone(): this;
/**
* Create filter statements to be applied to the OData request based on the linked entity values.
* @param filters - Filters based on the linked entity.
* @returns Newly created `FilterLink`.
*/
filter(...expressions: (Filterable<LinkedEntityT> | OneToManyLink<LinkedEntityT, any>)[]): this;
/**
* Add order-by statements to the request.
** @param orderBy - OrderBy statements to order the response by.
* @returns The request builder itself, to facilitate method chaining.
*/
orderBy(...orderBy: Orderable<LinkedEntityT>[]): this;
/**
* Number of returned entities.
* @param top - Maximum number of entities to return in the response. Can be less, if less entities match the request.
* @returns The request builder itself, to facilitate method chaining.
*/
top(top: number): this;
/**
* Skip number of entities.
* @param skip - Number of matching entities to skip. Useful for paging.
* @returns The request builder itself, to facilitate method chaining.
*/
skip(skip: number): this;
}
//# sourceMappingURL=one-to-many-link.d.ts.map