This document covers the details other classes.
The NewsData
[API]
class holds information about news. It has three dates:
startDate
, newsDate
and endDate
. The
news item is visible to everyone between the start and end dates. If the end date
is null, the news item is visible forever. The newsDate
is the date
that should be shown in the list. Most of the time this date is probably the same
as the start date, but it doesn't have to be.
ItemContext
:s
[API].
TODO - write documentation and add to UML image
Messages are mainly used for the system to notify a user when something, ie. a job
has been completed. A MessageData
[API]
holds information about the message. Information about the sender is kept in
the from
and fromId
properties. We didn't want to create
real links to a UserData
object for this since it is not necessarily
a user that sent the message. If it was sent by a user we only keep the id, since
we don't want a sent message to prevent a user from beeing deleted. The receiving
user is kept as a real link by the to
property, but the messages are
cascade deleted if that user is deleted.
If the message contains information about a completed job, that job is linked
in the job
property.
The AnyToAnyData
[API]
class allows us to create links between any two items. A link has a direction and name.
It starts at the from item leading to the to item. The link has a name
that must be unique for among all links for the from item. This allows
us to add meaning to the links. Ie. a plugin could link an Affymetrix raw bioassay
with a CEL file and CHP file.