From 243720ee96a4eb17b5a925e67b0ea862695fc577 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=82=8D=E3=82=80=E3=81=AD=E3=81=93?= Date: Thu, 14 Dec 2023 12:37:19 +0900 Subject: [PATCH] =?UTF-8?q?JavaDoc=E5=AF=BE=E5=BF=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../java/one/nem/lacerta/data/Document.java | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/data/src/main/java/one/nem/lacerta/data/Document.java b/data/src/main/java/one/nem/lacerta/data/Document.java index 36d2d2eb..835e66e4 100644 --- a/data/src/main/java/one/nem/lacerta/data/Document.java +++ b/data/src/main/java/one/nem/lacerta/data/Document.java @@ -7,14 +7,34 @@ import one.nem.lacerta.model.document.DocumentDetail; import one.nem.lacerta.model.document.path.DocumentPath; import one.nem.lacerta.model.document.tag.DocumentTag; +/** + * ドキュメントのデータを取得する + */ public interface Document { + /** + * 更新の新しいドキュメントから順に並べてlimit件取得する + * @param limit 取得する上限数 + */ ArrayList getRecentDocumentMetas(int limit); + /** + * 更新の新しいドキュメントから順に並べてoffset位置からlimit件取得する + * @param limit 取得する上限数 + * @param offset 取得するオフセット + */ ArrayList getRecentDocumentMetas(int limit, int offset); - // ドキュメント詳細取得 + /** + * ドキュメントIDからDocumentDetailを取得する + * @param id ドキュメントID + */ DocumentDetail getDocumentDetail(String id); + + /** + * DocumentMetaからDocumentDetailを取得する + * @param meta DocumentMeta + */ DocumentDetail getDocumentDetailByMeta(DocumentMeta meta); // 簡単に使えるように