okapi.coreobjects
Class OkapiToolController

java.lang.Object
  okapi.coreobjects.OkapiObject
      okapi.coreobjects.OkapiToolController

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

OkapiAddOcwMaterialTC, OkapiBBoardTC, OkapiClassCalendarTC, OkapiClassListTC, OkapiClassStaffTC, OkapiCourseworkTC, OkapiDefaultToolController, OkapiEditAccessGroupsTC, OkapiEditAnnouncementTC, OkapiEditClassMetadataTC, OkapiEditDocumentTC, OkapiEditEmailClassTC, OkapiEditEventTC, OkapiEditGroupTC, OkapiEditHelpTC, OkapiEditHomeImageTC, OkapiEditHomeworkDocumentTC, OkapiEditNavBarTC, OkapiEditNexusDescriptionTC, OkapiEditNexusMeetingsInfoTC, OkapiEditNexusSettingsTC, OkapiEditNexusToolsTC, OkapiEditNexusUserInfoTC, OkapiEditOcwClassCalendarTC, OkapiEditOcwMaterialTC, OkapiEditOcwToolPageTC, OkapiEditPageIntroTextTC, OkapiEditSampleTC, OkapiEditSectionDocumentsTC, OkapiEditSectionParticipantsTC, OkapiEditSectionsTC, OkapiEditTopicTC, OkapiEditUserSectionTC, OkapiEditUserTC, OkapiExportsTC, OkapiFacultyManageHomeworkTC, OkapiHomeworkManagementTC, OkapiMyStellarTC, OkapiOpinioSurveyTC, OkapiReturnContentTC, OkapiReturnPhotoTC, OkapiSakaiForumsTC, OkapiSakaiJForumTC, OkapiSakaiStatusTC, OkapiSDemoTC, OkapiSearchIndexerTC, OkapiSearchTC, OkapiShowAnnouncementsTC, OkapiShowClassPicturesTC, OkapiShowContentTC, OkapiShowEventTC, OkapiShowGroupsTC, OkapiShowHelpTC, OkapiShowHomeworkTC, OkapiShowOcwClassCalendarTC, OkapiShowOcwMaterialTC, OkapiShowOcwToolPageTC, OkapiShowSectionDocumentsTC, OkapiShowSectionTC, OkapiShowTopicsTC, OkapiStellarGradebookTC, OkapiStellarImagesTC, OkapiStudentManageHomeworkTC, OkapiSubjectHomePageTC, OkapiTransferTC

public class OkapiToolController
extends OkapiObject

A Tool represents something which presents output to the user. A given tool will present the same sort of data no matter where or how or by whom it is used (access controls may limit how much information is presented, but doesn't change the type of information). Examples of Tools include: bboard, home page, calendar, Coursework, syllabus, etc. The ToolController provides the interface to the Tool.

Version:

$Revision: 31044 $, $Date: 2008-09-02 17:08:01 -0400 (Tue, 02 Sep 2008) $

Author:

MIT Stellar team

See Also:

Serialized Form

Field Summary

protected int

toolControllerCode Unique database key OkapiToolControllerCode.

Fields inherited from class okapi.coreobjects.OkapiObject

createdBy, createdDate, description, lastModifiedBy, lastModifiedDate, longName, name, objectID, status

Constructor Summary

OkapiToolController()
Construct new OkapiToolController.

OkapiToolController(int toolCode)
Return the ToolController object for this toolControllerCode

Method Summary

protected static void	addToolToCache(int code, OkapiToolController tool) Add a toolController to the cache.
void	edit(java.util.List pathVector, java.lang.String pathSegment, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context, java.util.List nexusHistory, java.util.List views) Edit this tool.
boolean	equals(java.lang.Object o) override Object equals method to compare two toolControlleres
java.lang.String	getAsXml(java.util.Map options, java.lang.String tag, int indent) Overrides the method in OkapiObject to add Content specific information.
static OkapiToolController	getTC(int toolControllerCode) Get a toolController from the cache.
int	getToolControllerCode() Return toolCode of this tool
int	hashCode() override hashCode to use the database table sequence number
void	render(java.util.List path, java.lang.String pathSegment, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context, java.util.List nexusHistory, java.util.List views) Render this tool.
void	setToolControllerCode(int code) Set toolCode of this tool

Methods inherited from class okapi.coreobjects.OkapiObject

checkAuthorization, currentDateTimeOracle, getAsXml, getAsXml, getAsXml, getCreatedBy, getCreatedDate, getDescription, getLastModifiedBy, getLastModifiedDate, getLongName, getName, getObjectID, getStatus, isEncryptionRequired, refreshFromDB, setAuthorization, setCreatedBy, setCreatedDate, setDescription, setLastModifiedBy, setLastModifiedBy, setLastModifiedDate, setLongName, setName, setStatus, updateDB

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

toolControllerCode

protected int toolControllerCode

Unique database key OkapiToolControllerCode.

Constructor Detail

OkapiToolController

public OkapiToolController()

Construct new OkapiToolController.

OkapiToolController

public OkapiToolController(int toolCode)

Return the ToolController object for this toolControllerCode

Method Detail

getToolControllerCode

public int getToolControllerCode()

Return toolCode of this tool

setToolControllerCode

public void setToolControllerCode(int code)

Set toolCode of this tool

equals

public boolean equals(java.lang.Object o)

override Object equals method to compare two toolControlleres

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

override hashCode to use the database table sequence number

Overrides:

hashCode in class java.lang.Object

getTC

public static OkapiToolController getTC(int toolControllerCode)

Get a toolController from the cache.

addToolToCache

protected static void addToolToCache(int code,
                                     OkapiToolController tool)

Add a toolController to the cache. Each TC should be instantiated by the Site and register itself at that time.

render

public void render(java.util.List path,
                   java.lang.String pathSegment,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   javax.servlet.ServletContext context,
                   java.util.List nexusHistory,
                   java.util.List views)
            throws javax.servlet.ServletException,
                   java.io.IOException

Render this tool. This method is called by the Nexus when it has identified this as the tool to handle the request. pathSegment provides the pathSegment by which this tool was reached, and path is relative to that.

Throws:

javax.servlet.ServletException

java.io.IOException

edit

public void edit(java.util.List pathVector,
                 java.lang.String pathSegment,
                 javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response,
                 javax.servlet.ServletContext context,
                 java.util.List nexusHistory,
                 java.util.List views)
          throws javax.servlet.ServletException,
                 java.io.IOException

Edit this tool. This method is called by the Nexus when it has identified this as the tool to handle the request, and the HTTP method was POST.

Throws:

javax.servlet.ServletException

java.io.IOException

getAsXml

public java.lang.String getAsXml(java.util.Map options,
                                 java.lang.String tag,
                                 int indent)

Overrides the method in OkapiObject to add Content specific information. See OkapiObject.getAsXml(String tag, int indent) for more information about using the getAsXml methods.

Overrides:

getAsXml in class OkapiObject