TranslationServiceImpl - MastermindCMS Documentation

string

The Spring bean identifier containing the service being called.translationServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

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

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: GUEST. Bearer Token: not required.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

void

Argument	Type	Description
—	—	This method does not accept arguments.

init

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

TranslationsRepository

Argument	Type	Description
—	—	This method does not accept arguments.

getRepository

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

LanguageRepository

Argument	Type	Description
—	—	This method does not accept arguments.

getLanguageRepository

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

Deque<Map<String, Object>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

getPaginationFilter

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

LinkedHashSet<LocalizedText>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchTranslations

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

Page<LocalizedText>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchTranslationsPaged

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

List<LocalizedText>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.
`offset`	`String`	Passed through `args[1].1`.
`limit`	`String`	Passed through `args[2].2`.

searchTranslations

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

List<LocalizedText>

Argument	Type	Description
`regex`	`String`	Passed through `args[0].0`.

searchTranslationsById

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

List<LocalizedText>

Argument	Type	Description
—	—	This method does not accept arguments.

findTranslations

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

List<LocalizedText>

Argument	Type	Description
`lang`	`String`	Passed through `args[0].0`.

findTranslationsByLangCode

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

Map<String, String>

Argument	Type	Description
`lang`	`String`	Passed through `args[0].0`.

getTranslationsByLangCode

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

String

Argument	Type	Description
—	—	This method does not accept arguments.

getLangFromContext

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

Map<String, String>

Argument	Type	Description
`date`	`String`	Passed through `args[0].0`.

getTranslatedTimeDuration

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

LocalizedText

Argument	Type	Description
`id`	`String`	Passed through `args[0].0`.

getTranslationById

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

Map<String,String>

Argument	Type	Description
`id`	`String`	Passed through `args[0].0`.
`repositoryName`	`String`	Passed through `args[1].1`.

getTranslation

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

Map<String, String>

Argument	Type	Description
`id`	`String`	Passed through `args[0].0`.
`lang`	`String`	Passed through `args[1].1`.
`repositoryName`	`String`	Passed through `args[2].2`.

getTranslation

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

String

Argument	Type	Description
`id`	`String`	Passed through `args[0].0`.
`repositoryName`	`String`	Passed through `args[1].1`.

getTranslationValue

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

String

Argument	Type	Description
`id`	`String`	Passed through `args[0].0`.
`lang`	`String`	Passed through `args[1].1`.
`repositoryName`	`String`	Passed through `args[2].2`.

getTranslationValue

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

List<Language>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.
`offset`	`String`	Passed through `args[1].1`.
`limit`	`String`	Passed through `args[2].2`.

searchLanguages

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

List<Language>

Argument	Type	Description
—	—	This method does not accept arguments.

findLanguages

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

Optional<LocalizedText>

Argument	Type	Description
`translationAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createTranslation

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

Optional<Language>

Argument	Type	Description
`langAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createLanguage

Example JSON request object:

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

Request:

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

Optional<LocalizedText>

Argument	Type	Description
`translationAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

saveTranslation

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

Optional<LocalizedText>

Argument	Type	Description
`text`	`String`	Passed through `args[0].0`.
`articleId`	`String`	Passed through `args[1].1`.

saveArticle

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

Optional<Language>

Argument	Type	Description
`langAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

saveLanguage

Example JSON request object:

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

Request:

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

void

Argument	Type	Description
`translationId`	`String`	Passed through `args[0].0`.

removeTranslationAndClean

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

void

Argument	Type	Description
`translationIds`	`ArrayList<String>`	Passed through `args[0].0`.

removeTranslationsByIds

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

void

Argument	Type	Description
`langId`	`String`	Passed through `args[0].0`.

removeTranslationsByLanguage

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

void

Argument	Type	Description
`langId`	`String`	Passed through `args[0].0`.

removeLanguageAndClean

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

void

Argument	Type	Description
`languageIds`	`ArrayList<String>`	Passed through `args[0].0`.

removeLanguagesByIds

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

HashSet<LocalizedText>

Argument	Type	Description
`langEn`	`String`	Passed through `args[0].0`.
`langDe`	`String`	Passed through `args[1].1`.

getTranslations

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

List<Map<String, Object>>

Argument	Type	Description
`isUpp`	`String`	Passed through `args[0].0`.

getAlphabetForActiveLanguage

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

List<Map<String, Object>>

Argument	Type	Description
`isUpp`	`String`	Passed through `args[0].0`.
`language`	`String`	Passed through `args[1].1`.

getAlphabetForLanguage

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

String

Argument	Type	Description
—	—	This method does not accept arguments.

getDefaultLanguage

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

​Headers

​Methods

​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

Methods

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