File

libs/core/src/lib/api-communication/interfaces/service-connector-interfaces.ts

Index

Methods

Methods

createCsvDataExportLink
createCsvDataExportLink(internalId: string | InternalDatasetId, params?: HelgolandCsvExportLinkParams)
Parameters :
Name Type Optional
internalId string | InternalDatasetId No
params HelgolandCsvExportLinkParams Yes
Returns : Observable<string>
getCategories
getCategories(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getCategory
getCategory(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getDataset
getDataset(internalId: string | InternalDatasetId, filter: DatasetFilter)
Parameters :
Name Type Optional
internalId string | InternalDatasetId No
filter DatasetFilter No
Returns : Observable<HelgolandDataset>
getDatasetData
getDatasetData(dataset: HelgolandDataset, timespan: Timespan, params?: HelgolandDataFilter)
Parameters :
Name Type Optional
dataset HelgolandDataset No
timespan Timespan No
params HelgolandDataFilter Yes
Returns : Observable<HelgolandData>
getDatasetExtras
getDatasetExtras(internalId: string | InternalDatasetId)
Parameters :
Name Type Optional
internalId string | InternalDatasetId No
getDatasets
getDatasets(url: string, filter: DatasetFilter)
Parameters :
Name Type Optional
url string No
filter DatasetFilter No
Returns : Observable<HelgolandDataset[]>
getFeature
getFeature(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getFeatures
getFeatures(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getOffering
getOffering(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getOfferings
getOfferings(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getPhenomena
getPhenomena(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getPhenomenon
getPhenomenon(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getPlatform
getPlatform(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getPlatforms
getPlatforms(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getProcedure
getProcedure(id: string, url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
id string No
url string No
filter HelgolandParameterFilter No
getProcedures
getProcedures(url: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
url string No
filter HelgolandParameterFilter No
getServices
getServices(apiUrl: string, filter: HelgolandParameterFilter)
Parameters :
Name Type Optional
apiUrl string No
filter HelgolandParameterFilter No
import { Observable } from 'rxjs';

import { InternalDatasetId } from '../../dataset-api/internal-id-handler.service';
import { Category } from '../../model/dataset-api/category';
import { Offering } from '../../model/dataset-api/offering';
import { Phenomenon } from '../../model/dataset-api/phenomenon';
import { Procedure } from '../../model/dataset-api/procedure';
import { Timespan } from '../../model/internal/timeInterval';
import { HelgolandData, HelgolandDataFilter } from '../model/internal/data';
import { DatasetExtras, DatasetFilter, HelgolandDataset } from '../model/internal/dataset';
import { HelgolandCsvExportLinkParams, HelgolandParameterFilter } from '../model/internal/filter';
import { HelgolandPlatform } from '../model/internal/platform';
import { Feature } from './../../model/dataset-api/feature';
import { HelgolandService } from './../model/internal/service';

export interface HelgolandServiceInterface {

    getPlatforms(url: string, filter: HelgolandParameterFilter): Observable<HelgolandPlatform[]>;
    getPlatform(id: string, url: string, filter: HelgolandParameterFilter): Observable<HelgolandPlatform>;

    getCategories(url: string, filter: HelgolandParameterFilter): Observable<Category[]>;
    getCategory(id: string, url: string, filter: HelgolandParameterFilter): Observable<Category>;

    getOfferings(url: string, filter: HelgolandParameterFilter): Observable<Offering[]>;
    getOffering(id: string, url: string, filter: HelgolandParameterFilter): Observable<Offering>;

    getPhenomena(url: string, filter: HelgolandParameterFilter): Observable<Phenomenon[]>;
    getPhenomenon(id: string, url: string, filter: HelgolandParameterFilter): Observable<Phenomenon>;

    getProcedures(url: string, filter: HelgolandParameterFilter): Observable<Procedure[]>;
    getProcedure(id: string, url: string, filter: HelgolandParameterFilter): Observable<Procedure>;

    getFeatures(url: string, filter: HelgolandParameterFilter): Observable<Feature[]>;
    getFeature(id: string, url: string, filter: HelgolandParameterFilter): Observable<Feature>;

    getDatasets(url: string, filter: DatasetFilter): Observable<HelgolandDataset[]>;
    getDataset(internalId: string | InternalDatasetId, filter: DatasetFilter): Observable<HelgolandDataset>;

    getDatasetExtras(internalId: string | InternalDatasetId): Observable<DatasetExtras>;

    getDatasetData(dataset: HelgolandDataset, timespan: Timespan, params?: HelgolandDataFilter): Observable<HelgolandData>;

    createCsvDataExportLink(internalId: string | InternalDatasetId, params?: HelgolandCsvExportLinkParams): Observable<string>;

    getServices(apiUrl: string, filter: HelgolandParameterFilter): Observable<HelgolandService[]>;
}

export interface HelgolandServiceConnector extends HelgolandServiceInterface {
    name: string;
    canHandle(url: string): Observable<boolean>;
}

result-matching ""

    No results matching ""