okapi.coreobjects
Interface OkapiToolModel

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

OkapiAddOcwMaterialM, OkapiClassCalendarM, OkapiClassListM, OkapiClassStaffM, OkapiEditAccessGroupsM, OkapiEditAnnouncementM, OkapiEditClassMetadataM, OkapiEditDocumentM, OkapiEditEmailClassM, OkapiEditEventM, OkapiEditGroupM, OkapiEditHelpM, OkapiEditHomeImageM, OkapiEditHomeworkDocumentM, OkapiEditNavBarM, OkapiEditNexusDescriptionM, OkapiEditNexusMeetingsInfoM, OkapiEditNexusSettingsM, OkapiEditNexusToolsM, OkapiEditNexusUserInfoM, OkapiEditOcwClassCalendarM, OkapiEditOcwMaterialM, OkapiEditOcwToolPageM, OkapiEditPageIntroTextM, OkapiEditSampleM, OkapiEditSectionDocumentsM, OkapiEditSectionParticipantsM, OkapiEditSectionsM, OkapiEditTopicM, OkapiEditUserM, OkapiEditUserSectionM, OkapiExportsM, OkapiFacultyManageHomeworkM, OkapiHwAllSubmissionsM, OkapiHwAssignmentDetailsM, OkapiHwDeleteAssignmentM, OkapiHwDeleteCommentM, OkapiHwDeleteSubmissionM, OkapiHwEditAssignmentM, OkapiHwEditCommentM, OkapiHwEditGradeM, OkapiHwFindSubmissionsM, OkapiHwIndexM, OkapiHwSubmissionDetailsM, OkapiHwSubmitM, OkapiMyStellarM, OkapiReturnContentM, OkapiReturnPhotoM, OkapiSearchIndexerM, OkapiSearchM, OkapiShowAnnouncementsM, OkapiShowClassPicturesM, OkapiShowContentM, OkapiShowEventM, OkapiShowFacultyStaffM, OkapiShowGroupsM, OkapiShowHelpM, OkapiShowHomeworkM, OkapiShowOcwClassCalendarM, OkapiShowOcwMaterialM, OkapiShowOcwToolPageM, OkapiShowSampleM, OkapiShowSectionDocumentsM, OkapiShowSectionM, OkapiShowTopicsM, OkapiStudentManageHomeworkM, OkapiSubjectHomePageM, OkapiThreadDemoM, OkapiTransferM

public interface OkapiToolModel
extends java.io.Serializable

ToolModels perform authorization checking, assemble data from core objects, and return the result in the desired format. A ToolRenderer then transforms the result if needed and writes it to the user.

Version:

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

Author:

MIT Stellar team

Method Summary

OkapiToolModelReturn

returnObject(java.util.List pathVector, java.lang.String pathSegment, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context, java.util.List nexusHistory, java.lang.String requestedType) Return OkapiToolModelReturn object requestedType may be XML, DTL, HTML

Method Detail

returnObject

OkapiToolModelReturn returnObject(java.util.List pathVector,
                                  java.lang.String pathSegment,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.ServletContext context,
                                  java.util.List nexusHistory,
                                  java.lang.String requestedType)
                                  throws OkapiPermissionDeniedException,
                                         OkapiAuthenticationRequiredException

Return OkapiToolModelReturn object requestedType may be XML, DTL, HTML

Throws:

OkapiPermissionDeniedException

OkapiAuthenticationRequiredException