Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class Course

    Object
       |
       +--Course

class Course

Defined in obj-course.js
Version: 1.0
Author: mpollack

Field Summary
`array` | `chapters` Chapter objects in a sequential array
`array` | `chaptersID` Chapter objects in an associative array
`string` | `lang` The language of the course
`string` | `objname` Name given to identify object on debug
`string` | `oid` The course ID
`Main` | `par` Reference to parent object
`string` | `subtitle` The sub title of the course
`string` | `title` The title of the course

Constructor Summary
`Course(<Main> p)` Contains data tree for entire course

Method Summary
`void` | `dump()` Loops through entire course tree and sends information to the debug window if turned on
`Chapter` | `getChapterByID(<string> i)` Gets the chapter from a supplied ID
`void` | `getData()` sends the command to get the course data
`void` | `setData(<string> d)` Sets data on the object using a delimited string sent via the jshook api.

Field Detail

### chapters

    array chapters

Chapter objects in a sequential array

### chaptersID

    array chaptersID

Chapter objects in an associative array

### lang

    string lang

The language of the course

### objname

    string objname

Name given to identify object on debug

### oid

    string oid

The course ID

### par

    Main par

Reference to parent object

### subtitle

    string subtitle

The sub title of the course

### title

    string title

The title of the course

Constructor Detail

### Course

    Course(<Main> p)

Contains data tree for entire course

Parameters:

`p` - parent object reference

Version: 1.0
Author: mpollack

Method Detail

### dump

    void dump()

Loops through entire course tree and sends information to the debug window if turned on

### getChapterByID

    Chapter getChapterByID(<string> i)

Gets the chapter from a supplied ID

Parameters:

`i` - chapter id

Returns:

A Chapter instance

### getData

    void getData()

sends the command to get the course data

### setData

    void setData(<string> d)

Sets data on the object using a delimited string sent via the jshook api. The string is split and each entry is run through eval() to execute.

Parameters:

`d` - delimited string with js commands

Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Tue Mar 4 12:01:48 2008