D. Actions

Services or actions as they are called in this project determine what can be done with things by the caller of this library. Services are arranged from the perspective of the end-user. Prenotes circulates notifications between caretakers and staff. Notifications always concern children. A notification is never deleted and it can not be edited. Instead, a notification may be retracted effectively detaching it from streaming or blocked if deemed offensive or inappropriate.

#Caretaker# A caretaker is the legal guardian of a child registered at a daycare. Caretakers are uniquely identified by their email address. Caretakers can not switch or edit a registered email. Only daycare staff can issue access to Prenotes or transfer a profile from one email address to another. Issuing access for an email address will automatically dispatch an email with a confirmation code to the caretaker. Once the caretaker has confirmed their email they can use notifications and edit their profile.

##Confirmation## Daycare staff receive the email address of a caretaker and tie the address to one or more children at the daycare in what is called a handshake. The process is nearly identical when caretakers request transfer of their account to a different email address. Prenotes dispatches an email with a confirmation code when handshakes are created. The email will contain a link which completes confirmation and creates the caretaker's account. After confirming an account a caretaker can edit their profile. A profile in Prenotes is spartan (i.e. name, language and other settings that are specific to Prenotes). The account can be nuked by caretakers. This will delete entities in the database representing a caretaker but not any notifications they have created.

###Kids### The connection between caretakers and children is handled by staff. Caretakers must request outside of Prenotes the association or disassociation to children.

##Streaming## Prenotes streams notifications to the end-user. There is no search function. The idea is that notifications surface in an infinite scroll by order of creation time in descending order (i.e. the newest first). The ability to search might be added later. Prenotes acts like a fire hose giving the user the latest notifications upfront. A caretaker can create a notification by providing a message and the children related to the message. At least one child has to be related to a notification. Caretakers can retract a message they have created. This doesn't delete the message rather excludes it from being streamed. Caretakers can also reply to notifications streamed to them.

#Employee# Daycare staff are represented as employees in Prenotes. They are also users just like caretakers. The confirmation and streaming services allotted to caretakers are the same for employees. The administrator of the daycare or super user will issue a confirmation email to employees. The administrator for a daycare has special privileges. They can confirm and detach employees from the daycare. They also are only ones whom may create a guest employee to be used by substitutes or temporary staff. Employees may stream notifications for all children registered to the daycare. An employee may mark notifications created by caretakers as offensive or inappropriate.

##Kids## Only an employee of the daycare can register or take away a child. The child just like users will need a name which is treated as unique. To differentiate between children with the name a nickname must be assigned.

##Others## An employee can list the other employees at their daycare.

#Administrator# An administrator derives from an employee. It has special privileges to handshake employees, retract employees, create a guest employee per daycare and can grant administration rights to an employee. Any employee granted administration rights can act like an administrator except like can not pass on grants. An administrator can be active at one or more daycare sites. Administrators may stream notifications for all children registered to daycare sites they administrate. Administrators may hide notifications that are offensive or inappropriate.

#Super# Every instance of Prenotes has one or more super users. A super user will create or retract daycare sites. Each daycare has at least one administrator. There is a special function to send out confirmation emails to super users which is ought to be done at start up or restart of Prenotes. Super users may stream all notifications from any daycare site. A super user can see which administrators belong to a daycare.

#Startup# To do.