Faces Note Pads
Jump to navigation
Jump to search
|
Introduction[edit]
A small glossary for the used terms can be found under Miscellaneous.
Please enter all comments concerning the use cases on the discussion page.
Scenario[edit]
- A note pad should be like an electronic post-it for an album where the user can save private notes.
- Can be released together with the corresponding album
- Will automatically be withdrawn when withdrawing the corresponding album
- Two different sorts of note pads exist:
| Private note pad | Shared note pad | |
| Consists of | one or more user entries | one or more user entries and one or more log entries |
| Created | by the user for own albums and for albums the user is sharing | automatically by the system when sharing an album |
| Edited | all user entries can be edited and deleted by its owner | all user entries can be edited and deleted by all users |
| Deleted | by its owner | is not possible; when unsharing the album, it becomes a private note pad of the owner of the corresponding album |
| Quantity | one album can have several private note pads | can only exist once per album |
| Speciality | -- | when a user shares or unshares the album, this will be added to the note pad as a log entry automatically |
UC_FAC_NP_01 Create private note pad[edit]
Status/Schedule
- Status: in design
- Schedule:
Motivation
- The user wants to create an own private note pad for an own private album.
Pre-Condition
- A pending album is selected.
- The user is the owner or shared the selected album.
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to create a new private note pad for the selected album.
- The system displays a mask to enter the note pad name. Per default the note pad is always named as "Private note pad of Album Name".
- (Optionally) The user changes the default name of the note pad.
- The user confirms the entry.
- The system creates a private not pad with the given metadata (name and connection to the corresponding album) in the state pending and displays a message (MSG_FAC_AM_01). The use case ends successfully.
Actors Involved
- Account user
Remarks
- A user can create as many private note pads for an album as he likes. There will be no restriction.
UC_FAC_NP_02 Edit note pad[edit]
Status/Schedule
- Status: in design
- Schedule:
Motivation
- The user wants to edit a note pad.
Pre-Condition
- One note pad in the state pending is selected.
- The user is the owner or is sharing the notepad.
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to edit the selected note pad.
- The system displays the edit mask of the note pad.
- The user edits the note pad (edits/deletes one or more already existing user entries or creates one or more new user entries), optionally the note pad name and confirms his changes.
- The system saves the changes of the note pad and displays a message (MSG_FAC_AM_02). The use case ends successfully.
Actors Involved
- Account user
UC_FAC_NP_04 Delete note pad[edit]
Status/Schedule
- Status: in design
- Schedule:
Motivation
- The user wants to delete one of his private note pads because he doesn't need it any more.
Pre-Condition
- One private note pad in the state pending is selected.
- the user is the owner of the note pad.
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to delete the selected note pad.
- The system prompts for a confirmation of the deletion.
- The user confirms the deletion.
- The system deletes the selected note pad and displays a message (MSG_FAC_AM_04). The use case ends successfully.
Actors Involved
- Account user
UC_FAC_NP_05 Release note pad[edit]
Status/Schedule
- Status: in design
- Schedule:
Motivation
- The user wants to release a note pad do that it will be visible for all Faces users.
Pre-Condition
- One pending note pad is selected.
- The user is the owner of the note pad.
- The corresponding album is in state released or this use case is triggered by UC_FAC_AM_06 Release album (which means the corresponding album will be released at the same moment).
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to release the note pad.
- The system prompts for a confirmation of the releasing.
- The user confirms the releasing.
- The system changes the state of the note pad to released (it automatically goes to submitted and then to released) and displays a message (MSG_FAC_AM_05). The use case ends successfully.
Actors Involved
- Account user
Remarks
- When the corresponding album is not released, the release button for the note pad should be disabled. But to explain the user why he can not release the album, some information should be available as mouse over.
UC_FAC_NP_06 Withdraw note pad[edit]
Status/Schedule
- Status: in design
- Schedule:
Motivation
- The user wants to withdraw one of his published private note pads because it is out of date.
Pre-Condition
- One released note pad is selected.
- The user is the owner of the selected note pad.
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to withdraw the selected note pad.
- The system prompts for a reason for the withdrawal.
- The user enters a reason and confirms the withdrawal.
- The system changes the state of the note pad to “withdrawn” and stores the withdrawal comment. The system displays a message (MSG_FAC_AM_06). The use case ends successfully.
Actors Involved
- Account user
Comments
- A withdrawn note pad is still readable when the user ca the exact URL of the note pad (or the corresponding album). Wut it is no longer visible in the browse and search interface of the collection.
Additional Information[edit]
A note pad represents a separate item. The text on the note pad shall be actually a text file attached to this separate item. Note pad metadata can be additionally checked.
Note Pad Metadata Set[edit]
A new created note pad has following attributes:
- Title
- The title of the not pad which will be created automatically (e.g. "Private notepad for Album XY").
- (string, mandatory, once)
- Type
- The type of the note pad.
- (list, mandatory, once)
- List contains private, shared.
- Corresponding album
- The ID of the corresponding album.
- (eSciDoc Id, mandatory, once)
- Only mandatory for private note pads (shared note pads will be represented as a member of the album).
Properties[edit]
- State
- The state of the note pad.
- (list, mandatory, once)
- List contains pending, released, withdrawn.
- Owner
- The person who created the note pad.
- (user, mandatory, once)
- Shared users
- The users the note pad is shared with.
- (user, optional, many)
- Date created
- The creation date of the note pad.
- (timestamp, required, once)
- Date last modified
- The last modification date of the note pad.
- (timestamp, required, once)