TranslationServiceImpl - MastermindCMS Documentation

string

Идентификатор Spring bean, который содержит вызываемый сервис.translationServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST. Bearer Token: не требуется.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

void

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

init

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "init",
  "args": []
}

TranslationsRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getRepository

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

LanguageRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getLanguageRepository

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLanguageRepository",
  "args": []
}

Deque<Map<String, Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getPaginationFilter

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<LocalizedText>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchTranslations

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchTranslations",
  "args": [
    {
      "0": null
    }
  ]
}

Page<LocalizedText>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchTranslationsPaged

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchTranslationsPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<LocalizedText>

Аргумент	Тип	Описание
`query`	`String`	Передаётся через `args[0].0`.
`offset`	`String`	Передаётся через `args[1].1`.
`limit`	`String`	Передаётся через `args[2].2`.

searchTranslations

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchTranslations",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

List<LocalizedText>

Аргумент	Тип	Описание
`regex`	`String`	Передаётся через `args[0].0`.

searchTranslationsById

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchTranslationsById",
  "args": [
    {
      "0": null
    }
  ]
}

List<LocalizedText>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

findTranslations

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "findTranslations",
  "args": []
}

List<LocalizedText>

Аргумент	Тип	Описание
`lang`	`String`	Передаётся через `args[0].0`.

findTranslationsByLangCode

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "findTranslationsByLangCode",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
`lang`	`String`	Передаётся через `args[0].0`.

getTranslationsByLangCode

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslationsByLangCode",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getLangFromContext

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLangFromContext",
  "args": []
}

Map<String, String>

Аргумент	Тип	Описание
`date`	`String`	Передаётся через `args[0].0`.

getTranslatedTimeDuration

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslatedTimeDuration",
  "args": [
    {
      "0": null
    }
  ]
}

LocalizedText

Аргумент	Тип	Описание
`id`	`String`	Передаётся через `args[0].0`.

getTranslationById

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslationById",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String,String>

Аргумент	Тип	Описание
`id`	`String`	Передаётся через `args[0].0`.
`repositoryName`	`String`	Передаётся через `args[1].1`.

getTranslation

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslation",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
`id`	`String`	Передаётся через `args[0].0`.
`lang`	`String`	Передаётся через `args[1].1`.
`repositoryName`	`String`	Передаётся через `args[2].2`.

getTranslation

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslation",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

String

Аргумент	Тип	Описание
`id`	`String`	Передаётся через `args[0].0`.
`repositoryName`	`String`	Передаётся через `args[1].1`.

getTranslationValue

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslationValue",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

String

Аргумент	Тип	Описание
`id`	`String`	Передаётся через `args[0].0`.
`lang`	`String`	Передаётся через `args[1].1`.
`repositoryName`	`String`	Передаётся через `args[2].2`.

getTranslationValue

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslationValue",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

List<Language>

Аргумент	Тип	Описание
`query`	`String`	Передаётся через `args[0].0`.
`offset`	`String`	Передаётся через `args[1].1`.
`limit`	`String`	Передаётся через `args[2].2`.

searchLanguages

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchLanguages",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

List<Language>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

findLanguages

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "findLanguages",
  "args": []
}

Optional<LocalizedText>

Аргумент	Тип	Описание
`translationAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createTranslation

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createTranslation",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Language>

Аргумент	Тип	Описание
`langAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createLanguage

Пример JSON объекта запроса:

{
    "id":  null,
    "name":  null,
    "isoCode":  null,
    "translations":  null,
    "fallIntoObjects":  null
}

Request:

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createLanguage",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<LocalizedText>

Аргумент	Тип	Описание
`translationAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

saveTranslation

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveTranslation",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<LocalizedText>

Аргумент	Тип	Описание
`text`	`String`	Передаётся через `args[0].0`.
`articleId`	`String`	Передаётся через `args[1].1`.

saveArticle

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveArticle",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Optional<Language>

Аргумент	Тип	Описание
`langAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

saveLanguage

Пример JSON объекта запроса:

{
    "id":  null,
    "name":  null,
    "isoCode":  null,
    "translations":  null,
    "fallIntoObjects":  null
}

Request:

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveLanguage",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`translationId`	`String`	Передаётся через `args[0].0`.

removeTranslationAndClean

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeTranslationAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`translationIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

removeTranslationsByIds

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeTranslationsByIds",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`langId`	`String`	Передаётся через `args[0].0`.

removeTranslationsByLanguage

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeTranslationsByLanguage",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`langId`	`String`	Передаётся через `args[0].0`.

removeLanguageAndClean

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeLanguageAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`languageIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

removeLanguagesByIds

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeLanguagesByIds",
  "args": [
    {
      "0": null
    }
  ]
}

HashSet<LocalizedText>

Аргумент	Тип	Описание
`langEn`	`String`	Передаётся через `args[0].0`.
`langDe`	`String`	Передаётся через `args[1].1`.

getTranslations

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTranslations",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

List<Map<String, Object>>

Аргумент	Тип	Описание
`isUpp`	`String`	Передаётся через `args[0].0`.

getAlphabetForActiveLanguage

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAlphabetForActiveLanguage",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String, Object>>

Аргумент	Тип	Описание
`isUpp`	`String`	Передаётся через `args[0].0`.
`language`	`String`	Передаётся через `args[1].1`.

getAlphabetForLanguage

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAlphabetForLanguage",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getDefaultLanguage

{
  "beanId": "translationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getDefaultLanguage",
  "args": []
}

​Headers

​Методы

​init

​getRepository

​getLanguageRepository

​getPaginationFilter

​searchTranslations

​searchTranslationsPaged

​searchTranslations

​searchTranslationsById

​findTranslations

​findTranslationsByLangCode

​getTranslationsByLangCode

​getLangFromContext

​getTranslatedTimeDuration

​getTranslationById

​getTranslation

​getTranslation

​getTranslationValue

​getTranslationValue

​searchLanguages

​findLanguages

​createTranslation

​createLanguage

​saveTranslation

​saveArticle

​saveLanguage

​removeTranslationAndClean

​removeTranslationsByIds

​removeTranslationsByLanguage

​removeLanguageAndClean

​removeLanguagesByIds

​getTranslations

​getAlphabetForActiveLanguage

​getAlphabetForLanguage

​getDefaultLanguage

Headers

Методы

init

getRepository

getLanguageRepository

getPaginationFilter

searchTranslations

searchTranslationsPaged

searchTranslations

searchTranslationsById

findTranslations

findTranslationsByLangCode

getTranslationsByLangCode

getLangFromContext

getTranslatedTimeDuration

getTranslationById

getTranslation

getTranslation

getTranslationValue

getTranslationValue

searchLanguages

findLanguages

createTranslation

createLanguage

saveTranslation

saveArticle

saveLanguage

removeTranslationAndClean

removeTranslationsByIds

removeTranslationsByLanguage

removeLanguageAndClean

removeLanguagesByIds

getTranslations

getAlphabetForActiveLanguage

getAlphabetForLanguage

getDefaultLanguage