Difference between revisions of "Faces Note Pads"
Line 8: | Line 8: | ||
* A note pad should be like an '''electronic post-it for an album''' where the user can save private notes. | * A note pad should be like an '''electronic post-it for an album''' where the user can save private notes. | ||
* It should be about the size of half a page (similar to a text editor). | * It should be about the size of half a page (similar to a text editor). | ||
* | * Two different sorts of note pads exist: | ||
* | *# '''Private note pad''': | ||
* | *#* Is like a text document which can be edited by its owner | ||
* | *#* Can be created, deleted, released and withdrawn by its owner | ||
*#* One album can have several private note pads | |||
* | *#* Private note pads can be created for own albums and for albums the user is sharing | ||
*# '''Shared note pad''': | |||
''' | *#* Is like a log file, where users can add comments, but can not delete any input | ||
* When | *#* When a user shares or unshares the album, this will be added to the note pad as a log entry | ||
* | *#* Will automatically be created when sharing an album | ||
*#* Can be released and withdrawn by the owner | |||
*#* Will automatically be withdrawn when withdrawing the album | |||
*#* Can only exist once per album | |||
== UC_FAC_NP_01 Create private note pad == | == UC_FAC_NP_01 Create private note pad == |
Revision as of 11:00, 18 February 2009
|
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.
- It should be about the size of half a page (similar to a text editor).
- Two different sorts of note pads exist:
- Private note pad:
- Is like a text document which can be edited by its owner
- Can be created, deleted, released and withdrawn by its owner
- One album can have several private note pads
- Private note pads can be created for own albums and for albums the user is sharing
- Shared note pad:
- Is like a log file, where users can add comments, but can not delete any input
- When a user shares or unshares the album, this will be added to the note pad as a log entry
- Will automatically be created when sharing an album
- Can be released and withdrawn by the owner
- Will automatically be withdrawn when withdrawing the album
- Can only exist once per album
- Private note pad:
UC_FAC_NP_01 Create private note pad[edit]
Status/Schedule
- Status: in specification
- Schedule: R3.5
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 of 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 th 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 private note pad[edit]
Status/Schedule
- Status: in specification
- Schedule: R3.5
Motivation
- The user wants to edit a private note pad.
Pre-Condition
- One private note pad in the state pending is selected.
- The user is the owner of 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 file and the note pad name.
- The user edits the note pad, 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
[edit]
Status/Schedule
- Status: in specification
- Schedule: R3.5
Motivation
- The user wants to comment a shared note pad.
Pre-Condition
- One shared note pad in the state pending is selected.
- The user shares the note pad or is the owner of the note pad.
Triggers
- This use case can be included by following use cases
Steps
- The user chooses to add a comment on the selected shared note pad.
- The system displays the edit mask for comments of the note pad.
- The user enters a comment and saves his input.
- The system adds the comment together with a timestamp to the shared note pad and displays a message (MSG_FAC_AM_03). The use case ends successfully.
Actors Involved
- Account user
UC_FAC_NP_04 Delete private note pad[edit]
Status/Schedule
- Status: in specification
- Schedule: R3.5
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 specification
- Schedule: R3.5
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.
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
UC_FAC_NP_06 Withdraw note pad[edit]
Status/Schedule
- Status: in specification
- Schedule: R3.5
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
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)