From 8cfa9bd8af59efa035458e9a4354a96ae4bd6e51 Mon Sep 17 00:00:00 2001
From: Yuri Kuznetsov <yurikuzn@users.noreply.github.com>
Date: Sun, 6 Apr 2025 10:52:03 +0300
Subject: [PATCH] comments

---
 application/Espo/Core/Record/Service.php | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/application/Espo/Core/Record/Service.php b/application/Espo/Core/Record/Service.php
index ec6c734016..b53b7293cc 100644
--- a/application/Espo/Core/Record/Service.php
+++ b/application/Espo/Core/Record/Service.php
@@ -192,11 +192,14 @@ class Service implements Crud,
     /**
      * Read a record by ID. Access control check is performed.
      *
+     * Is not supposed to be directly used in customizations.
+     *
      * @param non-empty-string $id
      * @return TEntity
      * @throws NotFoundSilent If not found.
      * @throws Forbidden If no read access.
      * @noinspection PhpDocSignatureInspection
+     * @todo In v10.0, return ReadResult instead of Entity.
      */
     public function read(string $id, ReadParams $params): Entity
     {
@@ -597,11 +600,14 @@ class Service implements Crud,
     /**
      * Create a record.
      *
+     * Is not supposed to be directly used in customizations.
+     *
      * @return TEntity
      * @throws BadRequest
      * @throws Forbidden If no create access.
      * @throws Conflict
      * @noinspection PhpDocSignatureInspection
+     * @todo In v10.0, return CreateResult instead of Entity.
      */
     public function create(stdClass $data, CreateParams $params): Entity
     {
@@ -661,12 +667,15 @@ class Service implements Crud,
     /**
      * Update a record.
      *
+     * Is not supposed to be directly used in customizations.
+     *
      * @return TEntity
      * @throws NotFound If record not found.
      * @throws Forbidden If no access.
      * @throws Conflict
      * @throws BadRequest
      * @noinspection PhpDocSignatureInspection
+     * @todo In v10.0, return UpdateResult instead of Entity.
      */
     public function update(string $id, stdClass $data, UpdateParams $params): Entity
     {
@@ -746,6 +755,8 @@ class Service implements Crud,
     /**
      * Delete a record.
      *
+     * Is not supposed to be directly used in customizations.
+     *
      * @throws Forbidden
      * @throws BadRequest
      * @throws NotFound