@studyportals/domain-client 3.17.1 → 3.18.0

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

@@ -0,0 +1,34 @@
+import { ITracking } from "../../..";
+
+export interface ITrackedLink {
+
+	/**
+	 * Get an optional text describing the link (typically <a>-tags contents).
+	 *
+	 * @return string
+	 * @throws PropertyNotAvailableException
+	 */
+	getDescription(): string;
+
+	canShowDescription(): boolean;
+
+	/**
+	 * Get an object containing all information needed to properly track a link.
+	 *
+	 * @return ITracking
+	 */
+	getTracking(): ITracking;
+
+	/**
+	 * 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-tracking.ts

@@ -0,0 +1,55 @@
+import { IClickTrackingData } from "../../..";
+
+export interface ITracking {
+
+	/**
+	 * Get the value of the data-action attribute.
+	 *
+	 * @return string
+	 */
+	getAction(): string;
+
+	/**
+	 * Get all the data that is need to make click tracking possible
+	 *
+	 * @return IClickTrackingData
+	 */
+	getClickTrackingData(): IClickTrackingData;
+
+	canShowClickTrackingData(): boolean;
+
+	/**
+	 * Get the value of the data-description attribute.
+	 *
+	 * @return string
+	 */
+	getDescription(): string;
+
+	/**
+	 * Get the extra information value.
+	 *
+	 * @return string
+	 */
+	getExtra(): string;
+
+	/**
+	 * Get the value of the data-id attribute.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get the value of the data-label attribute.
+	 *
+	 * @return string
+	 */
+	getLabel(): string;
+
+	/**
+	 * Get the value of the data-type attribute.
+	 *
+	 * @return string
+	 */
+	getType(): string;
+}

package/src/models/programme-card/i-tuition-fee.ts

@@ -0,0 +1,57 @@
+export interface ITuitionFee {
+
+	/**
+	 * Get the tuition amount per unit in the provided currency.
+	 *
+	 * Note: all transformable units will be converted to yearly amounts. This
+	 * includes per semester and full programme tuition fees.
+	 *
+	 * @return number
+	 */
+	getAmount(): number;
+
+	/**
+	 * Get the applicable currency.
+	 *
+	 * @return string
+	 */
+	getCurrency(): string;
+
+	/**
+	 * Get the original tuition amount before any transformation step.
+	 *
+	 * @return number
+	 */
+	getOriginalAmount(): number;
+
+	/**
+	 * Get the original tuition unit before any transformation step.
+	 *
+	 * @return string
+	 */
+	getOriginalUnit(): string;
+
+	/**
+	 * Get targeted audience (national, international, eea, etc).
+	 *
+	 * @return string
+	 */
+	getTarget(): string;
+
+	/**
+	 * Get the unit the tuition fee applies for.
+	 *
+	 * Note: all transformable units will be converted to 'year'. This means
+	 * this value will be either 'year', 'module' or 'credit'.
+	 *
+	 * @return string
+	 */
+	getUnit(): string;
+
+	/**
+	 * True if the study is free for this target audience.
+	 *
+	 * @return boolean
+	 */
+	isFree(): boolean;
+}

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

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

package/src/models/ranking-cards/i-ranking-card.ts

@@ -0,0 +1,74 @@
+import { IRanking } from "../../..";
+
+export interface IRankingCard {
+
+	/**
+	 * Get the organisation city.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationCity(): string | null;
+
+	/**
+	 * Get the organisation country.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationCountry(): string | null;
+
+	/**
+	 * Get the organisation id.
+	 *
+	 * @return number
+	 */
+	getOrganisationId(): number;
+
+	/**
+	 * Get the organisation logo url.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationLogoUrl(): string | null;
+
+	/**
+	 * Get the organisation name.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationName(): string | null;
+
+	/**
+	 * Get the organisation homepage link.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationPageUrl(): string | null;
+
+	/**
+	 * Get the position for the organisation in the Studyportals ranking.
+	 *
+	 * @return number | null
+	 */
+	getPosition(): number | null;
+
+	/**
+	 * Get the year the organisation was ranked.
+	 *
+	 * @return string | null
+	 */
+	getRankingYear(): string | null;
+
+	/**
+	 * Get this organisation's ranked position for each available ranking.
+	 *
+	 * @return IRanking[]
+	 */
+	getRankings(): IRanking[];
+
+	/**
+	 * Verifies if the organisation's logo can be displayed.
+	 *
+	 * @return boolean
+	 */
+	hasOrganisationLogo(): boolean;
+}

package/src/models/ranking-cards/i-ranking-cards.ts

@@ -0,0 +1,18 @@
+import { IRankingCard } from "../../..";
+
+export interface IRankingCards {
+
+	/**
+	 * Retrieves the id of the collection.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Retrieves the collection of ranking cards.
+	 *
+	 * @return IRankingCard[]
+	 */
+	getRankingCards(): IRankingCard[];
+}

package/src/models/ranking-cards/i-ranking.ts

@@ -0,0 +1,22 @@
+export interface IRanking {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return number | null
+	 */
+	getRankingId(): number | null;
+
+	/**
+	 * @return number
+	 */
+	getPosition(): number;
+
+	/**
+	 * @return string
+	 */
+	getRankingYear(): string;
+}

package/src/models/ranking-cards/public-ranking-cards-client.ts

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

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

@@ -0,0 +1,26 @@
+export interface IScholarshipCard {
+
+	getDescriptionOfApplicationBasis(): string | null;
+
+	getDescriptionOfBenefits(): string | null;
+
+	getDescriptionOfDeadline(): string;
+
+	getDescriptionOfDestinationCountryRestrictions(): string;
+
+	getDescriptionOfProviderLocation(): string | null;
+
+	getProviderId(): string | null;
+
+	getProviderIsUniversity(): boolean;
+
+	getProviderLogoSquareCdn(): string | null;
+
+	getProviderName(): string;
+
+	getScholarshipId(): string;
+
+	getScholarshipTitle(): string;
+
+	getScholarshipVirtualName(): string;
+}

package/src/models/scholarship-card/public-scholarship-card-client.ts

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

package/src/models/search-country-faq/i-search-country-faq.ts

@@ -0,0 +1,22 @@
+export interface ISearchCountryFaq {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getName(): string;
+
+	/**
+	 * @return string
+	 */
+	getRankingCountryLink(): string;
+
+	/**
+	 * @return string[]
+	 */
+	getTopFiveUniversities(): string[];
+}

package/src/models/search-country-faq/public-search-country-faq-client.ts

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

package/src/models/search-discipline/i-search-discipline.ts

@@ -0,0 +1,32 @@
+export interface ISearchDiscipline {
+
+	/**
+	 * @return string | null
+	 */
+	getIcon(): string | null;
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getName(): string;
+
+	/**
+	 * @return string | null
+	 */
+	getOldVirtualPath(): string | null;
+
+	/**
+	 * @return number | null
+	 */
+	getParentId(): number | null;
+
+	/**
+	 * @return string
+	 */
+	getVirtualPath(): string;
+}

package/src/models/search-discipline/public-search-discipline-client.ts

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

package/src/models/search-projection/i-geo-targeting-configuration.ts

@@ -0,0 +1,44 @@
+export interface IGeoTargetingConfiguration {
+
+	/**
+	 * Bit set 1 of targeted country ID information.
+	 *
+	 * @return number
+	 */
+	getBit1(): number;
+
+	/**
+	 * Bit set 2 of targeted country ID information.
+	 *
+	 * @return number
+	 */
+	getBit2(): number;
+
+	/**
+	 * Bit set 3 of targeted country ID information.
+	 *
+	 * @return number
+	 */
+	getBit3(): number;
+
+	/**
+	 * Bit set 4 of targeted country ID information.
+	 *
+	 * @return number
+	 */
+	getBit4(): number;
+
+	/**
+	 * Bit set 5 of targeted country ID information.
+	 *
+	 * @return number
+	 */
+	getBit5(): number;
+
+	/**
+	 * List of all configured country IDs.
+	 *
+	 * @return number[]
+	 */
+	getTargetedCountries(): number[];
+}

package/src/models/search-projection/i-geo-targeting-values.ts

@@ -0,0 +1,38 @@
+import { IGeoTargetingConfiguration } from "../../..";
+
+export interface IGeoTargetingValues {
+
+	/**
+	 * Geo-targeting configuration for "light premium" listing.
+	 *
+	 * @return IGeoTargetingConfiguration
+	 */
+	getLightPremium(): IGeoTargetingConfiguration;
+
+	canShowLightPremium(): boolean;
+
+	/**
+	 * Geo-targeting configuration for "premium" listing.
+	 *
+	 * @return IGeoTargetingConfiguration
+	 */
+	getPremium(): IGeoTargetingConfiguration;
+
+	canShowPremium(): boolean;
+
+	/**
+	 * Geo-targeting configuration for "super premium" listing.
+	 *
+	 * @return IGeoTargetingConfiguration
+	 */
+	getSuperPremium(): IGeoTargetingConfiguration;
+
+	canShowSuperPremium(): boolean;
+
+	/**
+	 * Programme has active geo-targeting settings.
+	 *
+	 * @return boolean
+	 */
+	isGeoTargeted(): boolean;
+}

package/src/models/search-projection/i-organisation-values.ts

@@ -0,0 +1,46 @@
+export interface IOrganisationValues {
+
+	/**
+	 * Country ID of the top level organisation.
+	 *
+	 * @return number
+	 */
+	getCountryId(): number;
+
+	/**
+	 * ID of the programme's main organisation.
+	 *
+	 * First premium organisation or top level organisation.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Name of the programme's main organisation.
+	 *
+	 * First premium organisation or top level organisation.
+	 *
+	 * @return string
+	 */
+	getName(): string;
+
+	/**
+	 * List of all organisation IDs attached to the programme (main + sub).
+	 *
+	 * @return number[]
+	 */
+	getOrganisations(): number[];
+
+	/**
+	 * Region ID of the top level organisation.
+	 *
+	 * Currently only possible region ID is 38 (EEA region). All other regions
+	 * are ignored for this field.
+	 *
+	 * @return number
+	 */
+	getRegionId(): number;
+
+	canShowRegionId(): boolean;
+}

package/src/models/search-projection/i-premium-values.ts

@@ -0,0 +1,43 @@
+export interface IPremiumValues {
+
+	/**
+	 * Bottom of the premium probability range (between 0.0 asn 1.0).
+	 *
+	 * @return number
+	 */
+	getPremiumBottom(): number;
+
+	canShowPremiumBottom(): boolean;
+
+	/**
+	 * CPM value attached to the premium listing.
+	 *
+	 * @return number
+	 */
+	getPremiumCpm(): number;
+
+	canShowPremiumCpm(): boolean;
+
+	/**
+	 * Top of the premium probability range (between 0.0 asn 1.0).
+	 *
+	 * @return number
+	 */
+	getPremiumTop(): number;
+
+	canShowPremiumTop(): boolean;
+
+	/**
+	 * Short hand premium type (sp, p, lp, slp, sslp, b).
+	 *
+	 * @return string
+	 */
+	getPremiumType(): string;
+
+	/**
+	 * Premium weight value used in Cloudsearch commercial sorting.
+	 *
+	 * @return number
+	 */
+	getPremiumValue(): number;
+}