This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Join Group"

From BZFlagWiki
Jump to: navigation, search
m (New page: {{DesignDocument}} == Introduction == The purpose of this use case is to describe the process of a player joining a group. Use Case diagram The diagram shows ...)
 
(category link)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DesignDocument}}
+
{{Specification}}
  
 
== Introduction ==
 
== Introduction ==
The purpose of this use case is to describe the process of a player joining a group.
+
This use case describes the process a player will use to join a group. Some groups permit anyone to join them, others require that a request be approved by one of the groups managers (or founders).
  
[[Image:UC_Join_Goup.png|Use Case diagram]]
+
[[Image:UC_Join_Group.png|Use Case diagram]]
  
 
The diagram shows the requirements and rules the use case is responsible for (via the <<requirement>> stereotype).
 
The diagram shows the requirements and rules the use case is responsible for (via the <<requirement>> stereotype).
 +
  
 
== Pre-conditions ==
 
== Pre-conditions ==
Line 14: Line 15:
 
== Post conditions ==
 
== Post conditions ==
 
The actor has joined a player group or requested membership in a group.
 
The actor has joined a player group or requested membership in a group.
 +
 +
 +
== Included use cases ==
 +
[[Search for Groups]]
 +
  
 
== Requirements and rules realized ==
 
== Requirements and rules realized ==
 +
'''RQ10 Private groups are always closed'''<br />
 +
The system shall prevent the actor from joining a private group.<br />
  
 +
 +
'''RQ8 Groups have a membership policy''' <br />
 +
A groups membership policy determines whether a player can join the group or not.<br />
 +
* ''BR4 Open groups'' <br />
 +
The system shall enable any player to join a public group with an open membership policy.<br />
 +
 +
* ''BR5 By Request groups''<br />
 +
The system shall enable any player to request membership of a public group with a by-request membership policy.<br />
 +
 +
* ''BR6 Closed groups''<br />
 +
The system shall prevent any player from joining, or requesting to join, a public group with a closed membership policy.<br />
 +
 +
 +
'''RQ11 Track the status of membership requests'''<br />
 +
The system shall store and track the status of membership requests.<br />
 +
* ''BR7 Alert group managers''<br />
 +
The system shall notify group managers of a membership request for a group they manage.<br />
 +
 +
* ''BR9 Notification format''<br />
 +
They system shall use a forum private message, email message, and a message displayed on the group management system main page to alert group managers of pending requests. <br />
 +
 +
* ''BR10 Prevent duplicate requests'' <br />
 +
The system shall prevent players from requesting to join a group where they have a request for the same group pending, or a previous identical request was actioned within the last 30 days. <br />
  
 
== Flow of events ==
 
== Flow of events ==
 +
The flow of events describes the main actor actions and system responses in the execution of the use case.
 +
 +
[[Image:Activity_Join_Group.png|Activity diagram showing flow of events]]
  
  
 
== Messages ==
 
== Messages ==
 +
<properties>
 +
Step:= BF-9
 +
Condition:= Player added to group
 +
Message Number:= Msg 4
 +
Message Text:= You were successfully added to the following group(s) <<added group list>>. Additionally, your requests to join the following groups <<request group list>> have been sent to the respective group managers.
 +
</properties>
 +
[[Category:Group Manager]]

Latest revision as of 17:05, 5 December 2016

Picture Frame.png This page contains a specification document for an enhancement or feature. It is a work of collaborative development, and may not represent the final design. If you are not part of the development or design group, please post comments and suggestions on the talk page and not in the middle of the design.


Introduction[edit]

This use case describes the process a player will use to join a group. Some groups permit anyone to join them, others require that a request be approved by one of the groups managers (or founders).

Use Case diagram

The diagram shows the requirements and rules the use case is responsible for (via the <<requirement>> stereotype).


Pre-conditions[edit]

None


Post conditions[edit]

The actor has joined a player group or requested membership in a group.


Included use cases[edit]

Search for Groups


Requirements and rules realized[edit]

RQ10 Private groups are always closed
The system shall prevent the actor from joining a private group.


RQ8 Groups have a membership policy
A groups membership policy determines whether a player can join the group or not.

  • BR4 Open groups

The system shall enable any player to join a public group with an open membership policy.

  • BR5 By Request groups

The system shall enable any player to request membership of a public group with a by-request membership policy.

  • BR6 Closed groups

The system shall prevent any player from joining, or requesting to join, a public group with a closed membership policy.


RQ11 Track the status of membership requests
The system shall store and track the status of membership requests.

  • BR7 Alert group managers

The system shall notify group managers of a membership request for a group they manage.

  • BR9 Notification format

They system shall use a forum private message, email message, and a message displayed on the group management system main page to alert group managers of pending requests.

  • BR10 Prevent duplicate requests

The system shall prevent players from requesting to join a group where they have a request for the same group pending, or a previous identical request was actioned within the last 30 days.

Flow of events[edit]

The flow of events describes the main actor actions and system responses in the execution of the use case.

Activity diagram showing flow of events


Messages[edit]

Step: BF-9
Condition: Player added to group
Message Number: Msg 4
Message Text: You were successfully added to the following group(s) <<added group list>>. Additionally, your requests to join the following groups <<request group list>> have been sent to the respective group managers.