> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mastermindcms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FrameworkOperationServiceImpl

> Calling public service methods through the REST API: frameworkOperationServiceImpl

<ResponseField name="beanId" type="string">
  The Spring bean identifier containing the service being called.

  frameworkOperationServiceImpl
</ResponseField>

<ResponseField name="scope" type="string" default="PROTOTYPE">
  Bean scope. Use PROTOTYPE for service calls.
</ResponseField>

<ResponseField name="functionName" type="string">
  The public service method name shown in the signature below.
</ResponseField>

<ResponseField name="args" type="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.
</ResponseField>

## Headers

```http theme={null}
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

<ResponseField name="isValueEquals" type="boolean">
  | Argument      | Type     | Description                 |
  | ------------- | -------- | --------------------------- |
  | `val`         | `String` | Passed through `args[0].0`. |
  | `equalsToVal` | `String` | Passed through `args[1].1`. |

  ### isValueEquals

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isValueEquals",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isNotBlank" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `value`  | `String` | Passed through `args[0].0`. |

  ### isNotBlank

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isNotBlank",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isBlank" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `value`  | `String` | Passed through `args[0].0`. |

  ### isBlank

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isBlank",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isNotTrue" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `value`  | `String` | Passed through `args[0].0`. |

  ### isNotTrue

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isNotTrue",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isTrue" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `value`  | `String` | Passed through `args[0].0`. |

  ### isTrue

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isTrue",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isFileExists" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `path`   | `String` | Passed through `args[0].0`. |

  ### isFileExists

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isFileExists",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isFileExistsFromSystemRoot" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `path`   | `String` | Passed through `args[0].0`. |

  ### isFileExistsFromSystemRoot

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isFileExistsFromSystemRoot",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isFileExistsFromUploadRoot" type="boolean">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `path`   | `String` | Passed through `args[0].0`. |

  ### isFileExistsFromUploadRoot

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isFileExistsFromUploadRoot",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="isLanguageDetection" type="boolean">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### isLanguageDetection

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isLanguageDetection",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="getActiveLanguages" type="List<String>">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### getActiveLanguages

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getActiveLanguages",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="getTimeFromDate" type="Map<String, String>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `date`   | `String` | Passed through `args[0].0`. |

  ### getTimeFromDate

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getTimeFromDate",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getCurrentDate" type="Map<String, String>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `pattern` | `String` | Passed through `args[0].0`. |

  ### getCurrentDate

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getCurrentDate",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getFormattedDate" type="Map<String, String>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `date`    | `String` | Passed through `args[0].0`. |
  | `pattern` | `String` | Passed through `args[1].1`. |

  ### getFormattedDate

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getFormattedDate",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getFormattedDateFromTimestamp" type="Map<String, String>">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `timestamp` | `String` | Passed through `args[0].0`. |
  | `pattern`   | `String` | Passed through `args[1].1`. |

  ### getFormattedDateFromTimestamp

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getFormattedDateFromTimestamp",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getDaysTillEndDate" type="Map<String, Object>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `date`   | `String` | Passed through `args[0].0`. |

  ### getDaysTillEndDate

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getDaysTillEndDate",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getDatePlusYears" type="Map<String, Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `years`   | `String` | Passed through `args[0].0`. |
  | `pattern` | `String` | Passed through `args[1].1`. |

  ### getDatePlusYears

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getDatePlusYears",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getDaysTillEndDateFromTimestamp" type="Map<String, Object>">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `timestamp` | `String` | Passed through `args[0].0`. |

  ### getDaysTillEndDateFromTimestamp

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getDaysTillEndDateFromTimestamp",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="multiplyValueTo" type="Map<String, Object>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `val`    | `String` | Passed through `args[0].0`. |
  | `to`     | `String` | Passed through `args[1].1`. |

  ### multiplyValueTo

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "multiplyValueTo",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="divideValueTo" type="Map<String, Object>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `val`    | `String` | Passed through `args[0].0`. |
  | `to`     | `String` | Passed through `args[1].1`. |

  ### divideValueTo

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "divideValueTo",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="plusTwoValues" type="Map<String, Object>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `val1`   | `String` | Passed through `args[0].0`. |
  | `val2`   | `String` | Passed through `args[1].1`. |

  ### plusTwoValues

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "plusTwoValues",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getFileSize" type="Map<String, String>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `url`    | `String` | Passed through `args[0].0`. |
  | `dim`    | `String` | Passed through `args[1].1`. |

  ### getFileSize

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getFileSize",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getFileExtension" type="Map<String, String>">
  | Argument   | Type     | Description                 |
  | ---------- | -------- | --------------------------- |
  | `filePath` | `String` | Passed through `args[0].0`. |

  ### getFileExtension

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getFileExtension",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getFirstLetter" type="Map<String, String>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `text`   | `String` | Passed through `args[0].0`. |

  ### getFirstLetter

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getFirstLetter",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getCurrentSequence" type="Map<String, String>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `seqName` | `String` | Passed through `args[0].0`. |

  ### getCurrentSequence

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getCurrentSequence",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="transformJsonArrayToList" type="List<Map<String,Object>>">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `jsonArray` | `String` | Passed through `args[0].0`. |

  ### transformJsonArrayToList

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "transformJsonArrayToList",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getLangCode" type="String">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### getLangCode

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getLangCode",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="toLowerCase" type="Map<String, String>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `str`    | `String` | Passed through `args[0].0`. |

  ### toLowerCase

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "toLowerCase",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="toUpperCase" type="Map<String, String>">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `str`    | `String` | Passed through `args[0].0`. |

  ### toUpperCase

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "toUpperCase",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="restClientCall" type="Object">
  | Argument       | Type     | Description                 |
  | -------------- | -------- | --------------------------- |
  | `endpoint`     | `String` | Passed through `args[0].0`. |
  | `method`       | `String` | Passed through `args[1].1`. |
  | `jsonAsString` | `String` | Passed through `args[2].2`. |

  ### restClientCall

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "restClientCall",
    "args": [
      {
        "0": null,
        "1": null,
        "2": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="parseNestedDatabaseDocs" type="HashMap<Object, Object>">
  | Argument        | Type     | Description                 |
  | --------------- | -------- | --------------------------- |
  | `itemName`      | `String` | Passed through `args[0].0`. |
  | `nestedKey`     | `String` | Passed through `args[1].1`. |
  | `database`      | `String` | Passed through `args[2].2`. |
  | `jsonObjString` | `String` | Passed through `args[3].3`. |

  ### parseNestedDatabaseDocs

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "parseNestedDatabaseDocs",
    "args": [
      {
        "0": null,
        "1": null,
        "2": null,
        "3": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="languageAwareUrl" type="String">
  | Argument | Type     | Description                 |
  | -------- | -------- | --------------------------- |
  | `url`    | `String` | Passed through `args[0].0`. |

  ### languageAwareUrl

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "languageAwareUrl",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getCurrentWebSiteSettings" type="WebSiteSettings">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### getCurrentWebSiteSettings

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getCurrentWebSiteSettings",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="getCurrentBrandingSiteSettings" type="LinkedHashMap<String, Object>">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### getCurrentBrandingSiteSettings

  ```json theme={null}
  {
    "beanId": "frameworkOperationServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getCurrentBrandingSiteSettings",
    "args": []
  }
  ```
</ResponseField>