goodViberations: Functionality Specification

Introduction

goodViberations is a password manager app. It is a data entry app, the implementation of the app uses activities (forms in conventional terms) to perform the common CRUD operations on data (Create, Read, Update, Delete). Initially no encryption is defined for the data storage and retrieval. During development, it is easier to leave this out. The design uses a separate data layer and specification. In this way there is a single place where encryption can be added when everything else has been developed and works.

In order to successfully encapsulate the functionality required to define the data and to implement the CRUD operations on the data, functionality describes:

• The UI specification, the widgets present in each activity.
• The binding of the data structures to the UI
• The functionality of the app
• the navigation between activities, and the flow of data between activities

There can be quite a lot of functionality in an activity. For this reason, the documents have been organised so that one document describes one activity. All the documents are kept in the functionality folder.

Initially all the activities do not have a corresponding functionality document. The development process is to add one or more functionality specifications, generate the code, review the code, test that the generated activity works as expected. Once completed, additional activity specification documents can be added and the process of generation, review, testing can be repeated.

Activity design

• All the activity classes should be in the package com.j3t.dataentryapp.ui.activities
• All the activity classes should be in the folder src/main/java/com/j3t/dataentryapp/ui/activities
• The title is displayed at the top of the activity's view.
• The activity widgets are placed within a vertically scrolling view. This allows the activity's contents to be viewable by the user in portrait and landscape modes.
• Each widget is a class member variable, this allows for functionality to be added to alter the widget's appearance and behaviour at runtime.

App Specification documents

The following functionality specification documents currently exist to describe some of the functionality of the app:

• The AboutActivity functionality specification is located in AboutActivityFunctionality.html.
• The HelpActivity functionality specification is located in HelpActivityFunctionality.html
• The MainActivity functionality specification is located in MainActivityFunctionality.html
• The CreateNewStoreActivity functionality specification is located in CreateNewStoreFunctionality.html
• The ListEntriesActivity functionality specification is located in ListEntriesActivityFunctionality.html
• The ViewEntryActivity functionality specification is located in ViewEntryActivityFunctionality.html.

The data structures and functionality used in this app are described in DataLayer.html, this includes:

• The data layer specification is located in DataLayer.html.
• The data layer unit tests are located in DataLayerUnitTests.html.

As the project progresses, new functionality specifications are added. The activities which do not yet have a functionality specification have a UI specification. The UI specification is described in UIActivities.html.

Some terms used in this project are defined below:

Entry

An entry is defined to be a set of text fields, each field has a name and a value. Some fields are unique to an entry type, some are common to all entries. Some field values reflect a data type, and so have a syntax associated with them. For example:

• email must have a valid email address syntax,
• url must have a valid http url syntax.
• name by default, starts with an uppercase. It may be set to lowercase by the user of the app.
• name is unique, name is case insensitive for purposes of uniqueness. For example name with a value of "name", "Name" and "NAME" are all treated as the same in terms of sorting and uniqueness, so only one name field value of "name", "Name" or "NAME" can be present in the list of entries.
• name is not null,