Docs For Class suck_by

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/suck_by_agent.act.php (line 16)

Action
   |
   --WizardAction
      |
      --MainWindowAction
         |
         --suck_by_agentAction

Method Summary

void buildContent ()

string getHeadingText ()

boolean isAuthorizedToExecute ()

void refreshAgentDetails (mixed $agent)

void _figureOut (mixed $ldapName, mixed $agentId)

void _getCanonicalCourse (mixed $courseString)

void _getCourseOffering (mixed $can, mixed $term, mixed $courseString)

void _getCourseSection (mixed $offer, mixed $ldapName)

void _getTerm (mixed $termName)

void _getUsableProperties (mixed $agent)

Variables

Inherited Variables

Inherited from MainWindowAction

MainWindowAction::$_actionRows

Methods

buildContent (line 59)

Build the content for this action

since: 4/26/05
access: public

void buildContent ()

Redefinition of:

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

getHeadingText (line 48)

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.

isAuthorizedToExecute (line 26)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

refreshAgentDetails (line 197)

void refreshAgentDetails (mixed $agent)

_figureOut (line 275)

Given a string, figure out if ets a term from the three letter name, creating it if necesary

void _figureOut (mixed $ldapName, mixed $agentId)

_getCanonicalCourse (line 361)

void _getCanonicalCourse (mixed $courseString)

_getCourseOffering (line 419)

void _getCourseOffering (mixed $can, mixed $term, mixed $courseString)

_getCourseSection (line 471)

void _getCourseSection (mixed $offer, mixed $ldapName)

_getTerm (line 306)

Gets a term from the three letter name, creating it if necesary

void _getTerm (mixed $termName)

_getUsableProperties (line 505)

copied stright from edit_agent_detailsAction in the agent module

void _getUsableProperties (mixed $agent)

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()

Class suck_by_agentAction

Inherited Variables

Inherited Methods