Docs For Class createnewtermAction

Description

The MainWindowAction is an abstract class that provides a standard way of setting up and executing an action in the main window of the application. It provides a structure for accessing various parts of this main window, as well as delegating the implementation of some methods to decendent classes.

copyright: Copyright © 2005, Middlebury College
version: $Id: MainWindowAction.class.php,v 1.13 2007/09/19 14:04:41 adamfranco Exp $

Located in /polyphony/main/modules/coursemanagement/createnewterm.act.php (line 14)

Action
   |
   --WizardAction
      |
      --MainWindowAction
         |
         --createnewtermAction

Method Summary

void buildContent ()

object Wizard createWizard ()

string getHeadingText ()

string getReturnUrl ()

string getUnauthorizedMessage ()

boolean isAuthorizedToExecute ()

boolean saveWizard (string $cacheName)

Variables

Inherited Variables

Inherited from MainWindowAction

MainWindowAction::$_actionRows

Methods

buildContent (line 64)

Build the content for this action

since: 4/26/05
access: public

void buildContent ()

Redefinition of:

MainWindowAction::buildContent(): Build the content for this action.

createWizard (line 80)

Create a new Wizard for this action. Caching of this Wizard is handled by getWizard() and does not need to be implemented here.

since: 4/28/05
access: public

object Wizard createWizard ()

Redefinition of:

WizardAction::createWizard(): Create a new Wizard for this action. Caching of this Wizard is handled by getWizard() and does not need to be implemented here.

getHeadingText (line 53)

Return the heading text for this action, or an empty string.

since: 4/26/05
access: public

string getHeadingText ()

Redefinition of:

Action::getHeadingText(): Return the heading text for this action, or an empty string.

getReturnUrl (line 215)

Return the URL that this action should return to when completed.

since: 4/28/05
access: public

string getReturnUrl ()

Redefinition of:

WizardAction::getReturnUrl(): Return the URL that this action should return to when completed.

getUnauthorizedMessage (line 42)

Return the "unauthorized" string to pring

since: 4/26/05
access: public

string getUnauthorizedMessage ()

Redefinition of:

Action::getUnauthorizedMessage(): Answer the message to print when the user is not authorized to execute this action

isAuthorizedToExecute (line 24)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

saveWizard (line 172)

Save our results. Tearing down and unsetting the Wizard is handled by in runWizard() and does not need to be implemented here.

return: TRUE if save was successful and tear-down/cleanup of the Wizard should ensue.
since: 4/28/05
access: public

boolean saveWizard (string $cacheName)

string $cacheName

Redefinition of:

WizardAction::saveWizard(): Save our results. Tearing down and unsetting the Wizard is handled by in runWizard() and does not need to be implemented here.

Inherited Methods

Inherited From MainWindowAction

MainWindowAction::buildContent()
MainWindowAction::execute()
MainWindowAction::getActionRows()

Inherited From WizardAction

WizardAction::cancelWizard()
WizardAction::cleanCacheName()
WizardAction::closeWizard()
WizardAction::createWizard()
WizardAction::getReturnUrl()
WizardAction::getWizard()
WizardAction::runWizard()
WizardAction::saveWizard()

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()