Index: openacs-4/packages/acs-events/www/doc/requirements.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-events/www/doc/requirements.html,v diff -u -N -r1.1.1.1 -r1.1.1.1.28.1 --- openacs-4/packages/acs-events/www/doc/requirements.html 12 Jun 2001 03:56:20 -0000 1.1.1.1 +++ openacs-4/packages/acs-events/www/doc/requirements.html 22 Jun 2016 08:19:32 -0000 1.1.1.1.28.1 @@ -77,7 +77,7 @@

III.A Events

-An event is an activity associated with a temporal interval or +An event is an activity associated with a temporal interval or several such intervals. Events may have additional attributes as well. Examples of events include: "hitchhiking from 4pm to 5pm", "attending the InSync concert from 11pm to 1am at the Enormodome", et @@ -123,7 +123,7 @@

III.C Activities

-An activity is a thing that a person or people do, usually represented +An activity is a thing that a person or people do, usually represented by a gerundic phrase, such as "biking", "reserving a room", "travelling to Bhutan to achieve enlightenment", et cetera. Activities are represented via a name and a description. An activity can @@ -135,7 +135,7 @@

III.D Recurring Events

-Consider an event, say, an activity A performed on day D at time T. The ACS Events service allows applications to generate new events which are the same activity A performed on different days in the future, but at the same time of day T; such events are said to be recurrences of the primary event. Recurrences can happen on a daily, +Consider an event, say, an activity A performed on day D at time T. The ACS Events service allows applications to generate new events which are the same activity A performed on different days in the future, but at the same time of day T; such events are said to be recurrences of the primary event. Recurrences can happen on a daily, weekly, monthly, yearly or custom basis. The start and end dates of recurrences can be uniformly offset.

@@ -151,10 +151,10 @@

IV. Use-cases and User-scenarios

-Determine the types or classes of users who would use the +Determine the types or classes of users who would use the system, and what their experience would be like at a high-level. Sketch what their experience would be like and what actions they would -take, and how the system would support them. +take, and how the system would support them.

@@ -179,30 +179,30 @@

VI.A Data Model Requirements

-10.10 Events +10.10 Events

-10.10.10 The data model represents activities associated with sets +10.10.10 The data model represents activities associated with sets of time intervals.

-10.10.20 Events can optionally be associated with parties. +10.10.20 Events can optionally be associated with parties.

-10.10.30> Events can optionally recur. +10.10.30> Events can optionally recur.

-10.20 Time Interval Sets +10.20 Time Interval Sets

-10.20.10 A time interval consists of a start time and an end time. +10.20.10 A time interval consists of a start time and an end time.

-10.20.20 A time interval set consists of a set of associated time +10.20.20 A time interval set consists of a set of associated time intervals.

-10.20.30 Individual time intervals can be open ended. That is, the +10.20.30 Individual time intervals can be open ended. That is, the beginning time, ending time, or both may be null. The exact meaning of a null time is application dependent. However, as a suggestion, null end time could indicate events such as holidays or birthdays that @@ -212,150 +212,150 @@ time.

-10.30 Activities +10.30 Activities

-10.30.10 An activity has a name and a description. +10.30.10 An activity has a name and a description.

-10.30.20 An activity can be associated with a set of ACS objects. +10.30.20 An activity can be associated with a set of ACS objects.

-10.30.30 An event object can be a valid target for an activity. +10.30.30 An event object can be a valid target for an activity. This could indicate time dependencies, e.g. for workflow or project management.

-10.50 Recurring Events +10.50 Recurring Events

-10.50.10 The data model provides a table which describes how to generate +10.50.10 The data model provides a table which describes how to generate recurrences from a base event.

-10.50.20 Recurring on a daily basis should be supported.

+10.50.20 Recurring on a daily basis should be supported.

-10.50.30 Recurring on a weekly basis should be supported. For +10.50.30 Recurring on a weekly basis should be supported. For weekly recurrences, it should be possible to specify exactly which days of the week.

-10.50.40 Recurring every month on a particular date should be +10.50.40 Recurring every month on a particular date should be supported.

-10.50.50 Recurring every month on a particular day of a +10.50.50 Recurring every month on a particular day of a particular week should be supported.

-10.50.60 If a date in the 4th or 5th week of a month has been +10.50.60 If a date in the 4th or 5th week of a month has been selected, then an option should be presented allowing an item to recur on a particular day of the last week of a month.

-10.50.70 Recurring yearly on a particular date should be supported.

+10.50.70 Recurring yearly on a particular date should be supported.

-10.50.80 The data model should allow an application to provide a +10.50.80 The data model should allow an application to provide a custom recurrence function.

-10.50.90 It should be possible to specify an end date for +10.50.90 It should be possible to specify an end date for recurrences.

-10.50.100 It should be possible to specify no end date for recurrences. +10.50.100 It should be possible to specify no end date for recurrences.

-10.50.110 The service should enforce reasonable limits on the +10.50.110 The service should enforce reasonable limits on the amount of data used to represent recurring events. In other words, it should not be possible to fill the DB with thousands of rows representing a single recurring event, even if it recurs indefinitely.

-10.50.120 The service should provide a view for querying on +10.50.120 The service should provide a view for querying on those recurrences that aren't fully populated in the DB.

VI.B API Requirements

-20.10 Event API +20.10 Event API

-20.10.10 The service supports adding an event. +20.10.10 The service supports adding an event.

-20.10.15 The service supports setting the time interval set of +20.10.15 The service supports setting the time interval set of an event.

-20.10.20 The service supports setting the activity of an event. +20.10.20 The service supports setting the activity of an event.

-20.10.30 The service supports adding or deleting a party +20.10.30 The service supports adding or deleting a party mapping to an event.

-20.10.40 The service supports deleting a complete event. +20.10.40 The service supports deleting a complete event.

-20.20 Time Interval Set API +20.20 Time Interval Set API

-20.20.10 The service supports adding a time interval set. +20.20.10 The service supports adding a time interval set.

-20.20.20 The service supports adding a time interval to a set. +20.20.20 The service supports adding a time interval to a set.

-20.20.30 The service supports updating the start or end dates +20.20.30 The service supports updating the start or end dates of a time interval.

-20.20.40 The service supports deleting a time interval from a +20.20.40 The service supports deleting a time interval from a set.

-20.20.50 The service supports counting the number of time +20.20.50 The service supports counting the number of time intervals in a set.

-20.20.60 The service supports determining if a given interval +20.20.60 The service supports determining if a given interval overlaps a particular time interval set.

-20.30 Activity API +20.30 Activity API

-20.30.10 The service supports creating an activity. +20.30.10 The service supports creating an activity.

-20.30.20 The service supports deleting an activity. +20.30.20 The service supports deleting an activity.

-20.30.30 The service supports updating the name of an activity. +20.30.30 The service supports updating the name of an activity.

-20.30.40 The service supports updating the description of an activity. +20.30.40 The service supports updating the description of an activity.

-20.30.50 The service supports adding or deleting an object +20.30.50 The service supports adding or deleting an object mapping to an event.

-20.50 Recurrence API +20.50 Recurrence API

-20.50.10 The service supports adding recurrences of an event. +20.50.10 The service supports adding recurrences of an event.

-20.50.20 The service supports deleting recurrences of an event. +20.50.20 The service supports deleting recurrences of an event.

-20.50.30 The service supports uniformly offsetting the start or +20.50.30 The service supports uniformly offsetting the start or end times of time intervals of recurrences of an event.

-20.50.40 The service supports determining if an event recurs. +20.50.40 The service supports determining if an event recurs.

VII. Design and Implementation Notes

@@ -441,10 +441,10 @@

VIII. Revision History

- - - - +
Document Revision #Action Taken, Notes
+ + +
Document Revision #Action Taken, Notes When? By Whom?