Difference between revisions of "Faces Note Pads"
Line 34: | Line 34: | ||
'''Steps''' | '''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 ([[Faces_System_Messages|MSG_FAC_AM_01]]). The use case ends successfully. | |||
'''Actors Involved''' | '''Actors Involved''' | ||
Line 55: | Line 55: | ||
'''Pre-Condition''' | '''Pre-Condition''' | ||
* One private note pad is selected. | * One private note pad in the state pending is selected. | ||
* The user is the owner of the notepad. | * The user is the owner of the notepad. | ||
'''Triggers''' | '''Triggers''' | ||
* This use case can be included by following use cases | * This use case can be included by following use cases | ||
:* [[Faces_Browse_and_Display#UC_FAC_BD_12_View_note_pad|UC_FAC_BD_12 View note pad ]] | :* [[Faces_Browse_and_Display#UC_FAC_BD_12_View_note_pad|UC_FAC_BD_12 View note pad]] | ||
'''Steps''' | '''Steps''' | ||
Line 66: | Line 66: | ||
# The system displays the edit mask of the note pad file and the note pad name. | # 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 user edits the note pad, optionally the note pad name and confirms his changes. | ||
# The system saves the changes of the note pad. The use case ends successfully. | # The system saves the changes of the note pad and displays a message ([[Faces_System_Messages|MSG_FAC_AM_02]]). The use case ends successfully. | ||
'''Actors Involved''' | '''Actors Involved''' | ||
Line 80: | Line 80: | ||
'''Pre-Condition''' | '''Pre-Condition''' | ||
* One shared note pad is selected. | * One shared note pad in the state pending is selected. | ||
* The user shares the note pad or is the owner of the note pad. | * The user shares the note pad or is the owner of the note pad. | ||
Line 91: | Line 91: | ||
# The system displays the edit mask for comments of the note pad. | # The system displays the edit mask for comments of the note pad. | ||
# The user enters a comment and saves his input. | # The user enters a comment and saves his input. | ||
# The system adds the comment together with a timestamp to the shared note pad. The use case ends successfully. | # The system adds the comment together with a timestamp to the shared note pad and displays a message ([[Faces_System_Messages|MSG_FAC_AM_03]]). The use case ends successfully. | ||
'''Actors Involved''' | |||
* Account user | |||
== UC_FAC_NP_04 Delete private note pad == | |||
'''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 | |||
** [[Faces_Browse_and_Display#UC_FAC_BD_12_View_note_pad|UC_FAC_BD_12 View note pad]] | |||
'''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 ([[Faces_System_Messages|MSG_FAC_AM_04]]. The use case ends successfully. | |||
'''Actors Involved''' | '''Actors Involved''' | ||
* Account user | * Account user | ||
== | == UC_FAC_NP_05 Release note pad == | ||
'''Status/Schedule''' | '''Status/Schedule''' | ||
* Status: in specification | * Status: in specification | ||
Line 107: | Line 132: | ||
* One pending note pad is selected. | * One pending note pad is selected. | ||
* The user is the owner of the note pad. | * The user is the owner of the note pad. | ||
'''Triggers''' | |||
* This use case can be included by following use cases | |||
** [[Faces_Browse_and_Display#UC_FAC_BD_12_View_note_pad|UC_FAC_BD_12 View note pad]] | |||
'''Steps''' | '''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 ([[Faces_System_Messages|MSG_FAC_AM_05]]). The use case ends successfully. | |||
'''Actors Involved''' | '''Actors Involved''' | ||
* Account user | |||
== UC_FAC_NP_06 Withdraw note pad == | |||
== | |||
'''Status/Schedule''' | '''Status/Schedule''' | ||
* Status: in specification | * Status: in specification | ||
Line 122: | Line 152: | ||
'''Motivation''' | '''Motivation''' | ||
* The user wants to withdraw one of his published private note pads because it is out of date. | |||
'''Pre-Condition''' | '''Pre-Condition''' | ||
* One released note pad is selected. | |||
* The user is the owner of the selected note pad. | |||
'''Triggers''' | '''Triggers''' | ||
* This use case can be included by following use cases | |||
** [[Faces_Browse_and_Display#UC_FAC_BD_12_View_note_pad|UC_FAC_BD_12 View note pad]] | |||
'''Steps''' | '''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 ([[Faces_System_Messages|MSG_FAC_AM_06]]). The use case ends successfully. | |||
'''Actors Involved''' | '''Actors Involved''' | ||
* Account user | |||
== Additional Information == | == Additional Information == |
Revision as of 14:33, 17 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).
- As a note pad is like a text document, editing the not pad means editing the whole text.
- Editing an album and editing the related note pad are two separate use cases.
- Each user of an album gets one private note pad corresponding to the album which is only visible and editable for him.
- The note pad always stays in the state pending and can therefore be edited as long as it exists (independently from the state of the album)
- When creating an album, the related private note pad of the album owner will automatically be created by the system (use case "Create note pad" is not needed).
- The deletion of a note pad will also happen automatically when deleting the related album. It is not possible to delete a note pad by itself (but it is possible to delete all content (text) of the note pad, see UC_FAC_NP_02 Edit note pad).
Sharing an album
- When sharing an album, each shared user gets a private note pad for the album + one shared note pad for all shared users will be available.
- The shared note pad can be read and write by all shared users.
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
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. A note pad can have several states: pending, released, withdrawn.
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)
Properties[edit]
- State
- The state of the album.
- (list, mandatory, once)
- List contains private (per default), shared.
- Date created
- The creation date of the album.
- (timestamp, required, once)
- Date last modified
- The last modification date of the album.
- (timestamp, required, once)
Relations[edit]
- Is member of
- The relation to the album the note pad belongs to.
- (relation, mandatory, once)
- Is owned by
- The relation to the person the album is owned by.
- (relation, mandatory, once)
- Is shared by
- The relation to the person the album is shared by.
- (relation, optional, many)