@studyportals/domain-client 6.0.0-0 → 6.0.0-10

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

@@ -1,205 +1,212 @@
-import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
-export interface IProgrammeCard {
-    /**
-     * ISO code of the country the programme is taught.
-     * Formatted in UPPERCASE
-     *
-     * @return string | null
-     */
-    getCountryIsoCode(): string | null;
-    /**
-     * Get the Cover of the programme if available.
-     *
-     * @return ICover
-     */
-    getCover(): ICover;
-    canShowCover(): boolean;
-    /**
-     * Get the degree name of the programme.
-     *
-     * @return string
-     */
-    getDegree(): string;
-    /**
-     * @return number[] | null
-     */
-    getDisciplineIds(): number[] | null;
-    /**
-     * Get duration of the programme.
-     *
-     * @return IDuration
-     */
-    getDuration(): IDuration;
-    canShowDuration(): boolean;
-    getEnglishRequirements(): IEnglishRequirements | null;
-    getGPA(): IGPARequirement | null;
-    /**
-     * Get the programme id.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the programme level.
-     *
-     * @return string
-     */
-    getLevel(): string;
-    getLivingCost(): ILivingCost | null;
-    /**
-     * Get the locaiton the programme is located in.
-     *
-     * Uses the country based on the programmes venues.
-     *
-     * @return ILocation
-     */
-    getLocation(): ILocation;
-    canShowLocation(): boolean;
-    /**
-     * Get the location text the programme is located in
-     *
-     * Uses the country based on the programmes venues and isFullyOnline state
-     *
-     * @return string | null
-     */
-    getLocationText(): string | null;
-    /**
-     * Get the Logo of the programme if available.
-     *
-     * @return ILogo
-     */
-    getLogo(): ILogo;
-    canShowLogo(): boolean;
-    /**
-     * Returns premium type
-     * Such as Super premium, premium, light, etc..
-     *
-     * @return string
-     */
-    getPremiumType(): string;
-    /**
-     * Get a link to the programme page.
-     *
-     * The link contains the page path as url and the programme name as the
-     * link description.
-     *
-     * @return IInternalLink
-     */
-    getProgrammeLink(): IInternalLink;
-    /**
-     * Get programme's referral link
-     *
-     * @return ITrackedLink
-     */
-    getReferralLink(): ITrackedLink;
-    canShowReferralLink(): boolean;
-    /**
-     * Get the summary of the programme.
-     *
-     * @return string
-     */
-    getSummary(): string;
-    /**
-     * Get all start dates
-     *
-     * @return ITiming[]
-     */
-    getTimings(): ITiming[];
-    canShowTimings(): boolean;
-    /**
-     * Get the programme title.
-     *
-     * @return string
-     */
-    getTitle(): string;
-    /**
-     * Get the tracking information needed to track the impression on the card.
-     *
-     * @return ITracking
-     */
-    getTracking(): ITracking;
-    /**
-     * Get all tuition fees of the programme.
-     *
-     * @return ITuitionFee[]
-     */
-    getTuitionFees(): ITuitionFee[];
-    canShowTuitionFees(): boolean;
-    /**
-     * Get the programme's university global position percentage in Meta Ranking
-     *
-     * @return string | null
-     */
-    getUniversityGlobalPositionPercentage(): string | null;
-    /**
-     * Get the programme's university id
-     *
-     * @return number
-     */
-    getUniversityId(): number;
-    /**
-     * Get a link to the programme's university page.
-     *
-     * The link contains the page path as url and the university name as the
-     * link description.
-     *
-     * @return ILink
-     */
-    getUniversityLink(): ILink;
-    getWorkExperienceYears(): number | null;
-    getEcts(): number | null;
-    /**
-     * If a program is both on campus and online
-     *
-     * @return boolean
-     */
-    isBlended(): boolean;
-    /**
-     * If a program is given in fulltime
-     *
-     * @return boolean
-     */
-    isFullTime(): boolean;
-    /**
-     * If a program can only be taught online or not
-     *
-     * @return boolean
-     */
-    isFullyOnline(): boolean;
-    /**
-     * If a program is taught on campus
-     *
-     * @return boolean
-     */
-    isOnCampus(): boolean;
-    /**
-     * If a program can be taught online
-     *
-     * @return boolean
-     */
-    isOnline(): boolean;
-    /**
-     * If a program is given in parttime
-     *
-     * @return boolean
-     */
-    isPartTime(): boolean;
-    /**
-     * Public status of the programme.
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-    /**
-     * The last time the programme has been updated and verified
-     *
-     * @return Date
-     */
-    getLastUpdated(): Date;
-    /**
-     * Get the programme's campaign type
-     *
-     * @return number
-     */
-    getCampaignType(): number | null;
-}
+import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
+import { IReviewRating } from "../common/i-review-rating";
+export interface IProgrammeCard {
+    /**
+     * ISO code of the country the programme is taught.
+     * Formatted in UPPERCASE
+     *
+     * @return string | null
+     */
+    getCountryIsoCode(): string | null;
+    /**
+     * Get the Cover of the programme if available.
+     *
+     * @return ICover
+     */
+    getCover(): ICover;
+    canShowCover(): boolean;
+    /**
+     * Get the degree name of the programme.
+     *
+     * @return string
+     */
+    getDegree(): string;
+    /**
+     * @return number[] | null
+     */
+    getDisciplineIds(): number[] | null;
+    /**
+     * Get duration of the programme.
+     *
+     * @return IDuration
+     */
+    getDuration(): IDuration;
+    canShowDuration(): boolean;
+    getEnglishRequirements(): IEnglishRequirements | null;
+    getGPA(): IGPARequirement | null;
+    /**
+     * Get the programme id.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the programme level.
+     *
+     * @return string
+     */
+    getLevel(): string;
+    getLivingCost(): ILivingCost | null;
+    /**
+     * Get the locaiton the programme is located in.
+     *
+     * Uses the country based on the programmes venues.
+     *
+     * @return ILocation
+     */
+    getLocation(): ILocation;
+    canShowLocation(): boolean;
+    /**
+     * Get the location text the programme is located in
+     *
+     * Uses the country based on the programmes venues and isFullyOnline state
+     *
+     * @return string | null
+     */
+    getLocationText(): string | null;
+    /**
+     * Get the Logo of the programme if available.
+     *
+     * @return ILogo
+     */
+    getLogo(): ILogo;
+    canShowLogo(): boolean;
+    /**
+     * Returns premium type
+     * Such as Super premium, premium, light, etc..
+     *
+     * @return string
+     */
+    getPremiumType(): string;
+    /**
+     * Get a link to the programme page.
+     *
+     * The link contains the page path as url and the programme name as the
+     * link description.
+     *
+     * @return IInternalLink
+     */
+    getProgrammeLink(): IInternalLink;
+    /**
+     * Get programme's referral link
+     *
+     * @return ITrackedLink
+     */
+    getReferralLink(): ITrackedLink;
+    canShowReferralLink(): boolean;
+    /**
+     * Get the summary of the programme.
+     *
+     * @return string
+     */
+    getSummary(): string;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    canShowTimings(): boolean;
+    /**
+     * Get the programme title.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * Get the tracking information needed to track the impression on the card.
+     *
+     * @return ITracking
+     */
+    getTracking(): ITracking;
+    /**
+     * Get all tuition fees of the programme.
+     *
+     * @return ITuitionFee[]
+     */
+    getTuitionFees(): ITuitionFee[];
+    canShowTuitionFees(): boolean;
+    /**
+     * Get the programme's university global position percentage in Meta Ranking
+     *
+     * @return string | null
+     */
+    getUniversityGlobalPositionPercentage(): string | null;
+    /**
+     * Get the programme's university id
+     *
+     * @return number
+     */
+    getUniversityId(): number;
+    /**
+     * Get a link to the programme's university page.
+     *
+     * The link contains the page path as url and the university name as the
+     * link description.
+     *
+     * @return ILink
+     */
+    getUniversityLink(): ILink;
+    getWorkExperienceYears(): number | null;
+    getEcts(): number | null;
+    /**
+     * If a program is both on campus and online
+     *
+     * @return boolean
+     */
+    isBlended(): boolean;
+    /**
+     * If a program is given in fulltime
+     *
+     * @return boolean
+     */
+    isFullTime(): boolean;
+    /**
+     * If a program can only be taught online or not
+     *
+     * @return boolean
+     */
+    isFullyOnline(): boolean;
+    /**
+     * If a program is taught on campus
+     *
+     * @return boolean
+     */
+    isOnCampus(): boolean;
+    /**
+     * If a program can be taught online
+     *
+     * @return boolean
+     */
+    isOnline(): boolean;
+    /**
+     * If a program is given in parttime
+     *
+     * @return boolean
+     */
+    isPartTime(): boolean;
+    /**
+     * Public status of the programme.
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+    /**
+     * The last time the programme has been updated and verified
+     *
+     * @return Date
+     */
+    getLastUpdated(): Date;
+    /**
+     * Get the programme's campaign type
+     *
+     * @return number
+     */
+    getCampaignType(): number | null;
+    /**
+     * Get the review rating of the programme.
+     *
+     * @return IReviewRating | null
+     */
+    getReviewRating(): IReviewRating | null;
+}

package/src/models/programme-card/i-programme-card.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=i-programme-card.js.map
+export {};

package/src/models/programme-card/i-review-rating-domain.d.ts

@@ -1,6 +1,6 @@
-export interface IReviewRatingDomain {
-    getAverage(): number;
-    getAverageStarRating(): number;
-    getQuantity(): number;
-    hasEnoughQuantity(): boolean;
-}
+export interface IReviewRatingDomain {
+    getAverage(): number;
+    getAverageStarRating(): number;
+    getQuantity(): number;
+    hasEnoughQuantity(): boolean;
+}

package/src/models/programme-card/i-review-rating-domain.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=i-review-rating-domain.js.map
+export {};

package/src/models/programme-card/i-start-date.d.ts

@@ -1,33 +1,33 @@
-import { IDeadline } from "../../..";
-export interface IStartDate {
-    /**
-     * Get the date the programme starts on.
-     *
-     * @return Date
-     */
-    getDate(): Date;
-    /**
-     * Get a list of deadlines that apply to this start date.
-     *
-     * Note: In case of extendable start dates, all information in the
-     * Deadline objects has already been extended to the first available start
-     * date.
-     *
-     * @return IDeadline[]
-     * @throws PropertyNotAvailableException
-     */
-    getDeadlines(): IDeadline[];
-    canShowDeadlines(): boolean;
-    /**
-     * True if you can apply at any time for this programme (rolling admission)
-     *
-     * @return boolean
-     */
-    isApplyingAnytime(): boolean;
-    /**
-     * True if the start date has passed (you can't start at this date anymore).
-     *
-     * @return boolean
-     */
-    isPassed(): boolean;
-}
+import { IDeadline } from "../../..";
+export interface IStartDate {
+    /**
+     * Get the date the programme starts on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get a list of deadlines that apply to this start date.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline objects has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline[]
+     * @throws PropertyNotAvailableException
+     */
+    getDeadlines(): IDeadline[];
+    canShowDeadlines(): boolean;
+    /**
+     * True if you can apply at any time for this programme (rolling admission)
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the start date has passed (you can't start at this date anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

package/src/models/programme-card/i-start-date.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=i-start-date.js.map
+export {};

package/src/models/programme-card/i-timing.d.ts

@@ -1,45 +1,45 @@
-import { IDeadline, IStartDate } from "../../..";
-export interface ITiming {
-    /**
-     * Get the IDeadline applicable for this type and programme.
-     *
-     * Note: In case of extendable start dates, all information in the
-     * Deadline object has already been extended to the first available start
-     * date.
-     *
-     * @return IDeadline
-     * @throws PropertyNotAvailableException
-     */
-    getDeadline(): IDeadline;
-    canShowDeadline(): boolean;
-    /**
-     * Get the IStartDate applicable for this type and programme.
-     *
-     * Note: In case of extendable start dates, all information in the
-     * StartDate objects has already been extended to the first available start
-     * date.
-     *
-     * @return IStartDate
-     * @throws PropertyNotAvailableException
-     */
-    getStartDate(): IStartDate;
-    canShowStartDate(): boolean;
-    /**
-     * Type of user the timing is applicable to (e.g. general, eea, national).
-     *
-     * @return string
-     */
-    getType(): string;
-    /**
-     * True if the programme allows to apply at any time (rolling application).
-     *
-     * @return boolean
-     */
-    isApplyingAnytime(): boolean;
-    /**
-     * True if the programme can start at any time (rolling admission).
-     *
-     * @return boolean
-     */
-    isStartingAnytime(): boolean;
-}
+import { IDeadline, IStartDate } from "../../..";
+export interface ITiming {
+    /**
+     * Get the IDeadline applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline object has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline
+     * @throws PropertyNotAvailableException
+     */
+    getDeadline(): IDeadline;
+    canShowDeadline(): boolean;
+    /**
+     * Get the IStartDate applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * StartDate objects has already been extended to the first available start
+     * date.
+     *
+     * @return IStartDate
+     * @throws PropertyNotAvailableException
+     */
+    getStartDate(): IStartDate;
+    canShowStartDate(): boolean;
+    /**
+     * Type of user the timing is applicable to (e.g. general, eea, national).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the programme allows to apply at any time (rolling application).
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the programme can start at any time (rolling admission).
+     *
+     * @return boolean
+     */
+    isStartingAnytime(): boolean;
+}

package/src/models/programme-card/i-timing.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=i-timing.js.map
+export {};

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

@@ -1,29 +1,29 @@
-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;
-}
+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;
+}