@studyportals/domain-client 6.1.0-beta.0 → 6.1.0-beta.2

package/src/models/organisation-card/i-organisation-card.ts

@@ -1,73 +0,0 @@
-import { IReviewRating } from "../common/i-review-rating";
-import { IRankingDiscipline } from "./i-ranking-discipline";
-
-export interface IOrganisationCard {
-
-	getNumberOfProgrammesForBachelors(): number;
-
-	getNumberOfProgrammesForDistanceLearning(): number;
-
-	getNumberOfProgrammesForMasters(): number;
-
-	getNumberOfProgrammesForPhd(): number;
-
-	getNumberOfProgrammesForShortCourses(): number;
-
-	getOrganisationGlobalMetaRankingPosition(): number | null;
-
-	getOrganisationMetaRankingPositionsByDiscipline(): IRankingDiscipline[] | null;
-
-	getOrganisationGlobalPositionPercentage(): string | null;
-
-	getOrganisationHasDeliveryMethodBlended(): boolean;
-
-	getOrganisationHasDeliveryMethodOnCampus(): boolean;
-
-	getOrganisationHasDeliveryMethodOnline(): boolean;
-
-	getOrganisationId(): number;
-
-	getOrganisationIsPremium(): boolean;
-
-	getOrganisationLocationCityName(): string | null;
-
-	getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
-
-	getOrganisationLocationCountryIsoCode(): string | null;
-
-	getOrganisationLocationCountryName(): string | null;
-
-	getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
-
-	getOrganisationLocationAreaCode(): string | null;
-
-	getOrganisationLogoSquareCdn(): string | null;
-
-	getOrganisationMayShowCoverImage(): boolean;
-
-	getOrganisationMayShowLogoSquare(): boolean;
-
-	getOrganisationName(): string;
-
-	getOrganisationRelativeLinkOfDetailPage(): string;
-
-	getOrganisationSummary(): string | null;
-
-	getOrganisationVenuesCount(): number;
-
-	getScholarshipsCountForBachelors(): number;
-
-	getScholarshipsCountForMasters(): number;
-
-	getScholarshipsCountForPhd(): number;
-
-	isForProfitFunding(): boolean;
-
-	isNonProfitFunding(): boolean;
-
-	isPublicFunding(): boolean;
-
-	getCampaignType(): number;
-
-	getReviewRating(): IReviewRating | null;
-}

package/src/models/organisation-card/i-ranking-discipline.ts

@@ -1,6 +0,0 @@
-export interface IRankingDiscipline {
-
-	getDisciplineId(): number;
-
-	getPosition(): number | null;
-}

package/src/models/organisation-card/organisation-card-client.ts

@@ -1,16 +0,0 @@
-import { IOrganisationCard } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class OrganisationCardClient extends ModelClient<IOrganisationCard> {
-	protected getModelName(): string {
-		return 'organisation-card';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/organisation-for-search/i-organisation-for-search.ts

@@ -1,37 +0,0 @@
-export interface IOrganisationForSearch {
-
-	/**
-	 * Gets the ISO codes of all countries where the organisation has venues.
-	 *
-	 * @return string[]
-	 */
-	getIsoCodesOfCountriesOfVenues(): string[];
-
-	/**
-	 * Gets the ISO country code of the main location of the organisation
-	 *
-	 * @return string
-	 */
-	getMainLocationCountryIsoCode(): string;
-
-	/**
-	 * Gets the ID of the organisation.
-	 *
-	 * @return number
-	 */
-	getOrganisationId(): number;
-
-	/**
-	 * Gets the name of the organisation.
-	 *
-	 * @return string
-	 */
-	getOrganisationName(): string;
-
-	/**
-	 * Gets the virtual name of the organisation.
-	 *
-	 * @return string
-	 */
-	getOrganisationVirtualName(): string;
-}

package/src/models/organisation-for-search/public-organisation-for-search-client.ts

@@ -1,16 +0,0 @@
-import { IOrganisationForSearch } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class PublicOrganisationForSearchClient extends ModelClient<IOrganisationForSearch> {
-	protected getModelName(): string {
-		return 'organisation-for-search';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return true;
-	}
-}

package/src/models/organisation-search-document/i-organisation-search-document.ts

@@ -1,177 +0,0 @@
-export interface IOrganisationSearchDocument {
-
-	/**
-	 * Gets the ISO codes of all countries where the organisation has venues
-	 *
-	 * @return string[]
-	 */
-	getCountryIsoCodesOfVenues(): string[];
-
-	/**
-	 * Gets the ISO code of the main location of the organisation
-	 *
-	 * @return string
-	 */
-	getCountryIsoCodeOfMainLocation(): string;
-
-	/**
-	 * Returns the number of bachelors offered by the organisation
-	 *
-	 * @return number
-	 */
-	getNumberOfProgrammesForBachelors(): number;
-
-	/**
-	 * Returns the number of distance learning courses offered by the organisation
-	 *
-	 * @return number
-	 */
-	getNumberOfProgrammesForDistanceLearning(): number;
-
-	/**
-	 * Returns the number of masters offered by the organisation
-	 *
-	 * @return number
-	 */
-	getNumberOfProgrammesForMasters(): number;
-
-	/**
-	 * Returns the number of phds offered by the organisation
-	 *
-	 * @return number
-	 */
-	getNumberOfProgrammesForPhd(): number;
-
-	/**
-	 * Returns the number of short courses offered by the organisation
-	 *
-	 * @return number
-	 */
-	getNumberOfProgrammesForShortCourses(): number;
-
-	/**
-	 * Gets the ID of the organisation.
-	 *
-	 * @return number
-	 */
-	getOrganisationId(): number;
-
-	/**
-	 * Gets the premium type of the organisation
-	 * 
-	 * @return string | null
-	 */
-	getPremiumType(): string | null;
-
-	/**
-	 * Checks whether the organisation has studies taught both online and on campus
-	 *
-	 * @return boolean
-	 */
-	hasDeliveryMethodBlended(): boolean;
-
-	/**
-	 * Checks whether the organisation has studies taught on campus
-	 *
-	 * @return boolean
-	 */
-	hasDeliveryMethodOnCampus(): boolean;
-
-	/**
-	 * Checks whether the organisation has studies taught online
-	 *
-	 * @return boolean
-	 */
-	hasDeliveryMethodOnline(): boolean;
-
-	/**
-	 * Gets the IDs of all areas where the organisation has venues
-	 *
-	 * @return number[]
-	 */
-	identifyAreasOfVenues(): number[];
-
-	/**
-	 * Gets the disciplines of Bachelors programmes taught at the organisation
-	 * 
-	 * @return number[]
-	 */
-	identifyDisciplinesForBachelors(): number[];
-
-	/**
-	 * Gets the disciplines of Masters programmes taught at the organisation
-	 * 
-	 * @return number[]
-	 */
-	identifyDisciplinesForMasters(): number[];
-
-	/**
-	 * Gets the disciplines of PhD programmes taught at the organisation
-	 * 
-	 * @return number[]
-	 */
-	identifyDisciplinesForPhd(): number[];
-
-	/**
-	 * Gets the disciplines of short courses programmes taught at the organisation
-	 * 
-	 * @return number[]
-	 */
-	identifyDisciplinesForShortCourses(): number[];
-
-	/**
-	 * Gets the IDs of all regions (continents) where the organisation has venues
-	 *
-	 * @return number[]
-	 */
-	identifyRegionsOfVenues(): number[];
-
-	/**
-	 * Returns true when the organisation does not have a parent organisation
-	 *
-	 * @return boolean
-	 */
-	isMainOrganisation(): boolean;
-
-	/**
-	 * Indicates whether the organisation is published or not
-	 *
-	 * @return boolean
-	 */
-	isPublished(): boolean;
-
-	/**
-	 * Gets the city IDs for Masters programmes offered by the organisation
-	 *
-	 * @return array<number>
-	 */
-	getCityIdsForMasters(): number[];
-
-	/**
-	 * Gets the city IDs for Bachelors programmes offered by the organisation
-	 *
-	 * @return array<number>
-	 */
-	getCityIdsForBachelors(): number[];
-
-	/**
-	 * Gets the city IDs for PhD programmes offered by the organisation
-	 *
-	 * @return array<number>
-	 */
-	getCityIdsForPhd(): number[];
-
-	/**
-	 * Gets the city IDs for Short Courses programmes offered by the organisation
-	 *
-	 * @return array<number>
-	 */
-	getCityIdsForShortCourses(): number[];
-
-	/**
-	 * Gets the city IDs for Distance Learning programmes offered by the organisation
-	 *
-	 * @return array<number>
-	 */
-	getCityIdsForDistanceLearning(): number[];
-}

package/src/models/organisation-search-document/organisation-search-document-client.ts

@@ -1,16 +0,0 @@
-import { IOrganisationSearchDocument } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class OrganisationSearchDocumentClient extends ModelClient<IOrganisationSearchDocument> {
-	protected getModelName(): string {
-		return 'organisation-search-document';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/programme-card/i-click-tracking-data.ts

@@ -1,8 +0,0 @@
-export interface IClickTrackingData {
-
-	getAction(): string;
-
-	getCategory(): string;
-
-	getLabel(): string;
-}

package/src/models/programme-card/i-cover.ts

@@ -1,16 +0,0 @@
-export interface ICover {
-
-	/**
-	 * Get the file ID of the cover (as known in the system)
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the source URL for the cover.
-	 *
-	 * @return string
-	 */
-	getSource(): string;
-}

package/src/models/programme-card/i-deadline.ts

@@ -1,23 +0,0 @@
-export interface IDeadline {
-
-	/**
-	 * Get the date this deadline expires on.
-	 *
-	 * @return Date
-	 */
-	getDate(): Date;
-
-	/**
-	 * Get the deadline type (e.g. general, national, eea, etc).
-	 *
-	 * @return string
-	 */
-	getType(): string;
-
-	/**
-	 * True if the deadline has passed (e.g. you can't apply anymore).
-	 *
-	 * @return boolean
-	 */
-	isPassed(): boolean;
-}

package/src/models/programme-card/i-duration.ts

@@ -1,46 +0,0 @@
-export interface IDuration {
-
-	/**
-	 * Get the amount of periods the programme takes to complete.
-	 *
-	 * Note: Durations of more than 70 days (with period === 'days') are
-	 * automatically calculated back to an amount of months.
-	 *
-	 * @return number
-	 */
-	getAmount(): number;
-
-	/**
-	 * Get an optional textual description of the duration.
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Get the original duration amount before any calculations.
-	 *
-	 * @return number
-	 */
-	getOriginalDuration(): number;
-
-	/**
-	 * Get the original duration period before any calculations.
-	 *
-	 * @return string
-	 */
-	getOriginalPeriod(): string;
-
-	/**
-	 * Get the period this duration is provided in (days or months).
-	 *
-	 * Note: Durations of more than 70 days (with period === 'days') are
-	 * automatically calculated back to an amount of months.
-	 *
-	 * @return string
-	 */
-	getPeriod(): string;
-}

package/src/models/programme-card/i-internal-link.ts

@@ -1,32 +0,0 @@
-export interface IInternalLink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Returns on which portal a this link should link towards.
-	 *
-	 * @return string
-	 */
-	getPortalType(): string;
-
-	/**
-	 * Get the url to refer to.
-	 *
-	 * Note that the url provided is always a relative URL. A base URL is needed
-	 * to make it a full valid path.
-	 * The only exception is when an external link is provided (meaning, outside
-	 * of StudyPortals-maintained domains). In this case a full url will be
-	 * provided.
-	 *
-	 * @return string
-	 */
-	getUrl(): string;
-}

package/src/models/programme-card/i-link.ts

@@ -1,25 +0,0 @@
-export interface ILink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Get the url to refer to.
-	 *
-	 * Note that the url provided is always a relative URL. A base URL is needed
-	 * to make it a full valid path.
-	 * The only exception is when an external link is provided (meaning, outside
-	 * of StudyPortals-maintained domains). In this case a full url will be
-	 * provided.
-	 *
-	 * @return string
-	 */
-	getUrl(): string;
-}

package/src/models/programme-card/i-location.ts

@@ -1,22 +0,0 @@
-import { IOptionalLink } from "../../..";
-
-export interface ILocation {
-
-	getArea(): IOptionalLink;
-
-	canShowArea(): boolean;
-
-	getAreaId(): number;
-
-	getCity(): IOptionalLink;
-
-	getCityId(): number;
-
-	getCountry(): IOptionalLink;
-
-	getCountryId(): number;
-
-	getCountryIso(): string;
-
-	hasAreaId(): boolean;
-}

package/src/models/programme-card/i-logo.ts

@@ -1,16 +0,0 @@
-export interface ILogo {
-
-	/**
-	 * Get the file ID of the logo.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the imgix URL of the logo.
-	 *
-	 * @return string
-	 */
-	getSource(): string;
-}

package/src/models/programme-card/i-optional-link.ts

@@ -1,27 +0,0 @@
-export interface IOptionalLink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Get the url to refer to.
-	 *
-	 * Note that the url provided is always a relative URL. A base URL is needed
-	 * to make it a full valid path.
-	 * The only exception is when an external link is provided (meaning, outside
-	 * of StudyPortals-maintained domains). In this case a full url will be
-	 * provided.
-	 *
-	 * @return string
-	 */
-	getUrl(): string;
-
-	canShowUrl(): boolean;
-}