|Home >> All >> com >> RuntimeCollective >> webapps >> [ bean Javadoc ]|
com.RuntimeCollective.webapps.bean: Javadoc index of package com.RuntimeCollective.webapps.bean.
com.RuntimeCollective.webapps.bean: Webapps is the core module of Josephine.
Actor: Abstract class for all objects that wrap a registered user of a Runtime Webapp. Different modules will want to add to the properties of a basic User: the school module has Students and Staff, the content management system will have Authors etc. Each of these should be implemented as wrappers of User that implement this Actor interface. There are three ways of getting an Actor: If you have an existing User and want to 'promote' them to an Actor then construct a new actor using RuntimeParameters.getStore().create, and set the User with setUser. If there is an existing actor in the DB for which you ...
EntityBean: A javabean must implement this interface in order to be handled by the EntityBeanStore . As well as implementing this interface, all Entity Beans must define the following two constructors: EntityBean() - Return a new blank bean with a new unique id. Throw SQLException if not possible to generate new id. EntityBean(int id) - Generate a bean from the database corresponding to the given primary key. If there is no such bean in the database, then throw SQLException . Entity beans usually have other methods for getting various children or parent beans, and which access the database. The golden rule ...
WebFolder: Object that represents the webfolder of a user -- a directory that sits on the server and can be accessed using WebDav. This requires the following RuntimeParameters to be set: webfolderPath -- the fully-resolved path of the root directory for the webfolders (excluding trailing "/"). The webfolder for the user with id=0 would then be webfolderPath/0 etc. webfolderURL -- the fully-resolved URL of the root directory for the webfolders (including trailing "/", and leading "http://"). The webfolder for the user with id=0 would then be webfolderUrl/0 etc.
DateBean: A date (and optional time) entered by a user (system-generated dates can stick with java.util.Date.). This class wraps a java.util.Date turning it into a bean including convenience methods for setting its day/month/year/hour/second values, validating and displaying. Note - a DateBean set using an InputDateTag must be validated (using DateBean.isValid ) before the content is transferred to a bean. This method not only validates the date, but also sets the internal java.util.Date .
ModeratedExtension: This is an extension which can be stuck to any EntityBean, and allows for the storage of moderation information for that bean. Moderation is used as a mechanism for vetting content before it is displayed on the public site. This is different from the Publishable interface since there is no versioning or editing cycle involved. Once a moderator has approved a bean it will be public from there on. Current moderation behaviour is based on UserGroup s, i.e. beans are assigned moderators that belong to a specific group.
User: Interface for all objects that represent a registered user of a Runtime Webapp. SimpleUser provides a basic implementation of this interface. Different modules will want to add to the properties of a user: the school module has Students and Staff, the content management system will have Authors etc. These should be implemented as wrappers of User that implement the Actor interface.
Session: The Session object is the identification that a User has logged in, and when. It is particularly useful in conjunction with TrackedUsers. EditorCheckLogon supports it, but CheckLogon doesn't (yet). It is recommended to use the updateSessionTag at the top of all JSP pages, for the Session to be kept up-to-date.
TreeExtension: This is an extension which places the extended EntityBean into a tree, thus having 0/1 parent and 0/n children. The type of parents and children is unconstrained (EntityBeans, that is). A given EntityBean can belong to any number of trees, it will have 1/n TreeExtension(s) for each tree it belongs to.
LabelValue: A label value pair. A similar class to this wil be introduced int Struts 1.1. This class will take it's place until Struts 1.1 is used. Use this class when you require a collection that has a different label to the value. To allow for lazy loading of the Object use the id constructor.
Address: An address. Each user may have many different addresses associated with them -- billing address, home address, etc -- each of which may have a different name and nationality. These attributes typically default to the name and nationality of the user, but may be changed.
ScreenFlowState: A stack of local forwards for screens with a very simplistic workflow. Note: This class is currently under development. Highest level of workflow is the initial screen, lowest level is the furthest traversible screen in the flow.
AuditedExtension: This Extension can be used to collect creation/lastModified user/date on any EntityBean. To set audit data, simply user markAsCreated and markAsEdited. To view the data, getFor() the extension, and use its properties.
SequenceBean: An interface for beans that can be identified by a sequence property -- this can either be a string representing an integer or a single letter. The sequence is used to denote the order of beans within a BeanSequence .
Duplicable: Interface to implement if you want an EntityBean to be duplicable, that is, to make it possible to duplicate a bean into a new one, with the same properties, but a new id.
Versioned: Interface to implement if you want an EntityBean to be duplicable, that is, to make it possible to duplicate a bean into a new one, with the same properties, but a new id.
PermissionBean: A javabean implementing this interface can use the checkEdit and checkView custom tags to check edit and view permissions.
VersionedExtension: An extension which can be used to stick the Versioned behaviour to any Duplicable bean. This also adds a VersionNotes property to each version.
SimpleActor: A simple abstract implementation of the Actor interface that exposes the properties of the underlying User.
FormDate: A time stamp with bean style accessors which is the counterpart of ideas.tag.DateInputTag.
SimpleUser: Simple implementation of the User interface representing a user that has an address.
ServletFile: A wrapper to a DBFile which makes it more convenient to use in a servlet context.
BeanFileFolder: Object that represents a folder containing files associated with an EntityBean.
DBFile: Database entry which manages and refers to an file in the database
LoginCookie: LoginCookie.java Keeps track of users who want to stay logged in