Skip to content

Commit 5c2396e

Browse files
committed
java doc for flashcard set request model
1 parent d91ba12 commit 5c2396e

File tree

2 files changed

+34
-8
lines changed

2 files changed

+34
-8
lines changed

src/main/java/data_access_use_case/entity_request_models/CommonUserDsRequestModel.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* Application Business Rules
77
* @author Justin Li
88
*/
9+
910
public class CommonUserDsRequestModel {
1011
private final String username;
1112
private final String password;

src/main/java/data_access_use_case/entity_request_models/FlashcardSetDsRequestModel.java

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,38 +34,63 @@ public FlashcardSetDsRequestModel(String title, String description, boolean isPr
3434
this.ownerUsername = ownerUsername;
3535
this.flashcardIds = flashcardIds;
3636
}
37+
/**
38+
* Gets the flashcard set title.
39+
* @return the flashcard set title.
40+
*/
3741
public String getTitle() {
3842
return title;
3943
}
40-
44+
/**
45+
* Gets the flashcard set description.
46+
* @return the flashcard set description.
47+
*/
4148
public String getDescription() {
4249
return description;
4350
}
44-
51+
/**
52+
* Gets the flashcard privacy.
53+
* @return true if the flashcard set is private.
54+
*/
4555
public Boolean getIsPrivate() {
4656
return isPrivate;
4757
}
48-
58+
/**
59+
* Gets the flashcard set id.
60+
* @return the flashcard set id.
61+
*/
4962
public int getFlashcardSetId(){
5063
return flashcardSetId;
5164
}
52-
65+
/**
66+
* Gets the id of the user who created the flashcard set.
67+
* @return the if of the user who created the flashcard set.
68+
*/
5369
public String getOwnerUsername(){
5470
return ownerUsername;
5571
}
56-
72+
/**
73+
* Gets a list of all the flashcards in the flashcard set.
74+
* @return a list of all the flashcards in the flashcard set.
75+
*/
5776
public List<Integer> getFlashcardIds(){
5877
return flashcardIds;
5978
}
60-
79+
/**
80+
* Sets the flashcard set title.
81+
*/
6182
public void setTitle(String title) {
6283
this.title = title;
6384
}
64-
85+
/**
86+
* Sets the flashcard set description.
87+
*/
6588
public void setDescription(String description) {
6689
this.description = description;
6790
}
68-
91+
/**
92+
* Sets the flashcard set id.
93+
*/
6994
public void setFlashcardSetId(int flashcardSetId) {
7095
this.flashcardSetId = flashcardSetId;
7196
}

0 commit comments

Comments
 (0)