Документация
-
RDS
-
~RDS
- .configure()
-
.getUniversityModel() ⇒
Mongoose.model
-
.getWorkTypeModel() ⇒
Mongoose.model
-
.getSubjectModel() ⇒
Mongoose.model
-
~Subject
-
instance
-
.saveSubject() ⇒
Subject
-
.getTitle() ⇒
string
-
.saveSubject() ⇒
-
static
-
.isExist(id) ⇒
promise
-
.getById(id) ⇒
Promise
-
.getEnabled(query, skip) ⇒
promise
-
.getAll(query, skip) ⇒
promise
-
.getDisabled(query, skip) ⇒
promise
-
.setName(id, newTitle) ⇒
promise
-
.enable(id) ⇒
promise
-
.disable(id) ⇒
promise
-
.isExist(id) ⇒
-
instance
-
~Faculty
-
instance
-
.getShortTitle() ⇒
string
-
.formatForSearch(format) ⇒
object
-
.getShortTitle() ⇒
-
static
-
.getTitle() ⇒
string
-
.getTitle() ⇒
-
instance
-
~University
-
instance
-
.getTitle() ⇒
string
-
.getShortTitle() ⇒
String
-
.formatForSearch(format) ⇒
object
-
.saveUniversity() ⇒
university
-
.getTitle() ⇒
-
static
-
.getById(id) ⇒
Promise
-
.getFaculties(university, format,) ⇒
Promise
-
.getUniversities(format) ⇒
promise
-
.getUniversitiesByTitle(title, format) ⇒
Promise
-
.getFacultiesByTitle(title, university, format) ⇒
Promise
-
.isExist(university, faculty) ⇒
promise
-
.getUniversityAndFacultyTitles(university, faculty) ⇒
Promise
-
.createNew(title, shortTitle, street, building, city, rating) ⇒
promise
- .addFaculty(title, shortTitle)
-
.getById(id) ⇒
-
instance
-
~WorkType
-
instance
-
.saveType() ⇒
WorkType
-
.saveType() ⇒
-
static
-
.setName(id, newTitle) ⇒
Promise
-
.enable(id) ⇒
Promise
-
.disable(id) ⇒
Promise
-
.getById(id) ⇒
Promise
-
.getEnabled(query, skip) ⇒
Promise
-
.getAll(query, skip) ⇒
Promise
-
.getDisabled(query, skip) ⇒
Promise
-
.isExist(id) ⇒
Promise
-
.setName(id, newTitle) ⇒
-
instance
-
~RDS
RDS~RDS
Kind: inner class of RDS
-
~RDS
- .configure()
-
.getUniversityModel() ⇒
Mongoose.model
-
.getWorkTypeModel() ⇒
Mongoose.model
-
.getSubjectModel() ⇒
Mongoose.model
RDS.configure()
Настройка модуля
Kind: static method of RDS
Throws:
-
Error
, не смог подключиться к базе данных.
Mongoose.model
RDS.getUniversityModel() ⇒ Получение класса University для работы с типами работ
Kind: static method of RDS
Throws:
-
DbError
, 500 - модуль не был инициализирован
Mongoose.model
RDS.getWorkTypeModel() ⇒ Получение класса WorkType для работы с типами работ
Kind: static method of RDS
Throws:
-
DbError
, 500 - модуль не был инициализирован
Mongoose.model
RDS.getSubjectModel() ⇒ Получение класса Subject для работы с типами работ
Kind: static method of RDS
Throws:
-
DbError
, 500 - модуль не был инициализирован
RDS~Subject
Kind: inner class of RDS
Properties
Name | Type | Description |
---|---|---|
title | string |
название |
created | date |
дата создания |
updated | date |
дата обновления |
enabled | boolean |
Активен ли предмет? |
-
~Subject
-
instance
-
.saveSubject() ⇒
Subject
-
.getTitle() ⇒
string
-
.saveSubject() ⇒
-
static
-
.isExist(id) ⇒
promise
-
.getById(id) ⇒
Promise
-
.getEnabled(query, skip) ⇒
promise
-
.getAll(query, skip) ⇒
promise
-
.getDisabled(query, skip) ⇒
promise
-
.setName(id, newTitle) ⇒
promise
-
.enable(id) ⇒
promise
-
.disable(id) ⇒
promise
-
.isExist(id) ⇒
-
instance
Subject
subject.saveSubject() ⇒ Безопасное сохранение предмета
Kind: instance method of Subject
Throws:
-
DbError
, 500 - ошибка базы данных
string
subject.getTitle() ⇒ Получение имени предмета
Kind: instance method of Subject
this: {Subject}
promise
Subject.isExist(id) ⇒ Проверка существуюет ли такой предмет
Kind: static method of Subject
this: {Subject}
Fulfill: boolean
, true - предмет существует, false - предмета нет.
Reject: DbError
, 500 - ошибка бд
Param | Description |
---|---|
id | идентификатор предмета |
Promise
Subject.getById(id) ⇒ Получение предмета по id
Kind: static method of Subject
this: {Subject}
Fulfill: Subject
- все прошло хорошо
Reject: DbError
, 404 - не найден предмет по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор предмета |
promise
Subject.getEnabled(query, skip) ⇒ Поиск/получение неактивированных предметов
Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
promise
Subject.getAll(query, skip) ⇒ Поиск/получение по всем предметам
Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
promise
Subject.getDisabled(query, skip) ⇒ Поиск/получение неактивированных предметов
Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
promise
Subject.setName(id, newTitle) ⇒ Изменение title у предмета,
Kind: static method of Subject
this: {Subject}
Reject: DbError
, 400 - нарушена уникальность названия
Reject: DbError
, 500 - ошибка бд
Fulfill: Subject
объект типа Subject
Param | Description |
---|---|
id | идентификатор |
newTitle | новое название |
promise
Subject.enable(id) ⇒ Активация предмета по id,
Kind: static method of Subject
this: {Subject}
Fulfill: WorkType
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор работы |
promise
Subject.disable(id) ⇒ Дизактивация работы по id
Kind: static method of Subject
this: {Subject}
Fulfill: WorkType
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор работы |
RDS~Faculty
Kind: inner class of RDS
Properties
Name | Type | Description |
---|---|---|
title | string |
полное название |
shortTitle | string |
сокращенное название |
created | date |
дата создания |
updated | date |
дата обновления |
id | mongoose.Types.ObjectId |
идентификатор |
-
~Faculty
-
instance
-
.getShortTitle() ⇒
string
-
.formatForSearch(format) ⇒
object
-
.getShortTitle() ⇒
-
static
-
.getTitle() ⇒
string
-
.getTitle() ⇒
-
instance
string
faculty.getShortTitle() ⇒ Kind: instance method of Faculty
Summary: Получение краткого названия университета
Returns: string
- - краткое название
this: {Faculty}
object
faculty.formatForSearch(format) ⇒ Kind: instance method of Faculty
Summary: Метод для форматирования факультетов или университетов для выдачи
Returns: object
- formatted faculty
this: {Faculty}
Param | Type | Description |
---|---|---|
format | boolean |
true - длинное(title), false - краткое(shortTitle) |
string
Faculty.getTitle() ⇒ Kind: static method of Faculty
Summary: Получение названия университета
Returns: string
- - название
this: {Faculty}
RDS~University
Kind: inner class of RDS
Properties
Name | Type | Description |
---|---|---|
title | String |
полное название |
shortTitle | String |
сокращенное название |
faculties | Array.<Faculty> |
массив факультетов |
location.city | String |
Город |
location.street | String |
улица |
location.building | string |
Номер дома |
rating | number |
рейтинг университета |
created | date |
дата создания |
updated | date |
дата обновления |
enabled | boolean |
Активен ли предмет? |
_id | mongoose.Types.ObjectId |
идентификатор |
-
~University
-
instance
-
.getTitle() ⇒
string
-
.getShortTitle() ⇒
String
-
.formatForSearch(format) ⇒
object
-
.saveUniversity() ⇒
university
-
.getTitle() ⇒
-
static
-
.getById(id) ⇒
Promise
-
.getFaculties(university, format,) ⇒
Promise
-
.getUniversities(format) ⇒
promise
-
.getUniversitiesByTitle(title, format) ⇒
Promise
-
.getFacultiesByTitle(title, university, format) ⇒
Promise
-
.isExist(university, faculty) ⇒
promise
-
.getUniversityAndFacultyTitles(university, faculty) ⇒
Promise
-
.createNew(title, shortTitle, street, building, city, rating) ⇒
promise
- .addFaculty(title, shortTitle)
-
.getById(id) ⇒
-
instance
string
university.getTitle() ⇒ Kind: instance method of University
Summary: Получение названия университета
Returns: string
- - название
this: {University}
String
university.getShortTitle() ⇒ Kind: instance method of University
Summary: Получение краткого названия университета
Returns: String
- - краткое название
this: {University}
object
university.formatForSearch(format) ⇒ Kind: instance method of University
Summary: Метод для форматирования факультетов или университетов для выдачи
Returns: object
- formatted University
this: {University}
Param | Type | Description |
---|---|---|
format | boolean |
true - длинное(title), false - краткое(shortTitle) |
university
university.saveUniversity() ⇒ Kind: instance method of University
Summary: Безопасное сохранение университета
Throws:
-
DbError
, 500 - ошибка базы данных
Promise
University.getById(id) ⇒ Kind: static method of University
Summary: Получение университета по id
this: {University}
Fulfill: University
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор типа |
Promise
University.getFaculties(university, format,) ⇒ Kind: static method of University
Summary: Метод для получения списка факультетов в рамках одного универа по id
this: {University}
Fulfill: - Массив для выдачи
Reject{dberror},: 204 - не найдено факультетов
Reject: DbError
, 500 - ошибка базы данных.
Param | Type | Description |
---|---|---|
university | string |
id университета |
format, | boolean |
true - длинное(title), false - краткое(shortTitle) |
promise
University.getUniversities(format) ⇒ Kind: static method of University
Summary: Метод для получения списка универов
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError
, 204 - не найдено университетов
Reject: DbError
, 500 - ошибка базы данных.
Param | Type | Description |
---|---|---|
format | boolean |
true - длинное(title), false - краткое(shortTitle) |
Promise
University.getUniversitiesByTitle(title, format) ⇒ Kind: static method of University
Summary: Получение университетов по названию
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError
, 204 - не найдено университетов
Reject: DbError
, 500 - ошибка базы данных.
Param | Type | Description |
---|---|---|
title | строка поиска | |
format | boolean |
true - длинное(title), false - краткое(shortTitle) |
Promise
University.getFacultiesByTitle(title, university, format) ⇒ Kind: static method of University
Summary: Получение университетов по названию
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError
, 204 - не найдено университетов
Reject: DbError
, 500 - ошибка базы данных.
Param | Type | Description |
---|---|---|
title | строка для поиска | |
university | идентификатор университета | |
format | boolean |
true - длинное(title), false - краткое(shortTitle) |
promise
University.isExist(university, faculty) ⇒ Kind: static method of University
Summary: Метод проверки валидности университета и факультета
this: {University}
Fulfill: boolean
, true - данные валидны, false - данные не валидны
Reject: DbError
, 500 - ошибка базы данных
Param | Description |
---|---|
university | идентификатор университета |
faculty | идентификатор факульета |
Promise
University.getUniversityAndFacultyTitles(university, faculty) ⇒ Kind: static method of University
Summary: Метод, возвращающий названия факультета и университета
this: {University}
Fulfill: object
, проперти university, faculty
Reject: DbError
, 500 - ошибка базы данных
Param | Description |
---|---|
university | идентификатор университета |
faculty | идентификатор факульета |
promise
University.createNew(title, shortTitle, street, building, city, rating) ⇒ Kind: static method of University
Summary: Добавление нового университета
this: {University}
Param | Description |
---|---|
title | полное название |
shortTitle | краткое название |
street | улица/проспект |
building | номер дома |
city | город |
rating | рейтинг |
University.addFaculty(title, shortTitle)
Kind: static method of University
Summary: Добавление нового факультета в университет
Throws:
-
ValidationError
, 400 - Факультет уже присутствует в университете
this: {University}
Param | Description |
---|---|
title | полное название |
shortTitle | краткое название |
RDS~WorkType
Kind: inner class of RDS
Properties
Name | Type | Description |
---|---|---|
title | string |
название |
created | date |
дата создания |
updated | date |
дата обновления |
enabled | boolean |
Активен ли предмет? |
tags | Array.<string> |
Тэги |
-
~WorkType
-
instance
-
.saveType() ⇒
WorkType
-
.saveType() ⇒
-
static
-
.setName(id, newTitle) ⇒
Promise
-
.enable(id) ⇒
Promise
-
.disable(id) ⇒
Promise
-
.getById(id) ⇒
Promise
-
.getEnabled(query, skip) ⇒
Promise
-
.getAll(query, skip) ⇒
Promise
-
.getDisabled(query, skip) ⇒
Promise
-
.isExist(id) ⇒
Promise
-
.setName(id, newTitle) ⇒
-
instance
WorkType
workType.saveType() ⇒ Безопасное сохранение типа
Kind: instance method of WorkType
Throws:
-
DbError
, 500 - ошибка базы данных
Promise
WorkType.setName(id, newTitle) ⇒ Изменение title у типа работы
Kind: static method of WorkType
this: {WorkType}
Fulfil: WorkType
, объект типа WorkType
Reject: DbError
, 400 - нарушена уникальность названия
Reject: DbError
, 404 - нет типа с таким названием
Reject: DbError
, 500 - ошибка бд
Param | Description |
---|---|
id | идентификатор типа работы |
newTitle | новое название |
Promise
WorkType.enable(id) ⇒ Активация работы по id
Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор работы |
Promise
WorkType.disable(id) ⇒ Дизактивация работы по id
Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор работы |
Promise
WorkType.getById(id) ⇒ Получение типа по id
Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType
- все прошло хорошо
Reject: DbError
, 404 - не найден тип по id
Reject: DbError
, 500 - ошибка базы данных.
Param | Description |
---|---|
id | идентификатор типа |
Promise
WorkType.getEnabled(query, skip) ⇒ Поиск/получение неактивированных типов
Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
Promise
WorkType.getAll(query, skip) ⇒ Поиск/получение по всем типам работ
Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
Promise
WorkType.getDisabled(query, skip) ⇒ Поиск/получение неактивированных типов
Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError
, 204 - ничего не найдено
Reject: DbError
, 500 - ошибка сервера бд
Param | Type | Description |
---|---|---|
query | опционально. Строка для поиска | |
skip | number |
сколько страниц пропускаем сначала? |
Promise
WorkType.isExist(id) ⇒ Проверка существуюет ли такой тип
Kind: static method of WorkType
this: {WorkType}
Fulfill: boolean
, true - тип существует, false - типа нет.
Reject: DbError
, 500 - ошибка бд
Param | Description |
---|---|
id | идентификатор типа |