JavaDoc対応

This commit is contained in:
ろむねこ 2023-12-14 12:37:19 +09:00
parent ec81dfd525
commit 243720ee96
No known key found for this signature in database
GPG Key ID: FA1F39A1BA37D168

View File

@ -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.path.DocumentPath;
import one.nem.lacerta.model.document.tag.DocumentTag; import one.nem.lacerta.model.document.tag.DocumentTag;
/**
* ドキュメントのデータを取得する
*/
public interface Document { public interface Document {
/**
* 更新の新しいドキュメントから順に並べてlimit件取得する
* @param limit 取得する上限数
*/
ArrayList<DocumentMeta> getRecentDocumentMetas(int limit); ArrayList<DocumentMeta> getRecentDocumentMetas(int limit);
/**
* 更新の新しいドキュメントから順に並べてoffset位置からlimit件取得する
* @param limit 取得する上限数
* @param offset 取得するオフセット
*/
ArrayList<DocumentMeta> getRecentDocumentMetas(int limit, int offset); ArrayList<DocumentMeta> getRecentDocumentMetas(int limit, int offset);
// ドキュメント詳細取得 /**
* ドキュメントIDからDocumentDetailを取得する
* @param id ドキュメントID
*/
DocumentDetail getDocumentDetail(String id); DocumentDetail getDocumentDetail(String id);
/**
* DocumentMetaからDocumentDetailを取得する
* @param meta DocumentMeta
*/
DocumentDetail getDocumentDetailByMeta(DocumentMeta meta); // 簡単に使えるように DocumentDetail getDocumentDetailByMeta(DocumentMeta meta); // 簡単に使えるように