phpDocumentor KuoteInterfaces
Object
[ class tree: KuoteInterfaces ] [ index: KuoteInterfaces ] [ all elements ]

Interface: KuoteInterfaces_LearningOffering

Source Location: /classes/KuoteInterfaces/LearningOffering.php

Interface KuoteInterfaces_LearningOffering

Interface Overview

KuoteInterfaces_LearningOffering This intefaces defines the set of methods that all LearningOffering implementations need to function as part of the Kuote System.

Located in /classes/KuoteInterfaces/LearningOffering.php [line 18]



		
				Author(s):
		
  • Kyle Hall
Information Tags:
Copyright:  2006

Methods

[ Top ]
Method Summary
static array   getLearningOfferingsHash()   Returns a hashed array of learnings offerings for the given Learning Id.
integer   getCourseOfferingId()   Returns the Id of the Course Offering this Learning Offering is part of.
string   getEnd()   Returns the end date of the offering in the form "YYYY-MM-DD".
integer   getLearningId()   Returns the Id of the Learning this Learning Offering is offering.
boolean   getQuestionsRandom()   Declares if the questions for this Learning Offering's quiz should be displayed randomly.
boolean   getQuestionsRandomByDifficulty()   Declares if the questions for this Learning Offering's quiz should be displayed randomly, but only randomly within increasing difficuly.
string   getStart()   Returns the start date of the offering in the form "YYYY-MM-DD".
string   getTitle()   Returns the title of the Learning Offering.
boolean   setCourseOfferingId()   Sets the Id of the Course Offering this Learning Offering is part of.
boolean   setEnd()   Sets the ending date of an offering.
boolean   setLearningId()   Sets the Id of the Learning this Learning Offering is offering.
boolean   setQuestionsRandom()   Sets if the questions for this Learning Offering's quiz should be displayed randomly.
boolean   setQuestionsRandomByDifficulty()   Sets if the questions for this Learning Offering's quiz should be displayed randomly by difficutly.
boolean   setStart()   Sets the starting date of an offering.
boolean   setTitle()   Sets the title of the Learning Offering

[ Top ]
Methods
static method getLearningOfferingsHash  [line 152]

  static array getLearningOfferingsHash( integer $learningId  )

Returns a hashed array of learnings offerings for the given Learning Id.

Returns a hashed array of the format

  1. $id => $title

Parameters:
integer   $learningId:  Learning for which to find offerings.

API Tags:
Return:  Hashed array of $id => $title OR boolean False if no offerings are found.
Access:  public


[ Top ]
getCourseOfferingId  [line 117]

  integer getCourseOfferingId( )

Returns the Id of the Course Offering this Learning Offering is part of.


API Tags:
Return:  Course Offering Id.
Access:  public


[ Top ]
getEnd  [line 56]

  string getEnd( )

Returns the end date of the offering in the form "YYYY-MM-DD".


API Tags:
Return:  Date "YYYY-MM-DD".
Access:  public


[ Top ]
getLearningId  [line 132]

  integer getLearningId( )

Returns the Id of the Learning this Learning Offering is offering.


API Tags:
Return:  Learning Id.
Access:  public


[ Top ]
getQuestionsRandom  [line 75]

  boolean getQuestionsRandom( )

Declares if the questions for this Learning Offering's quiz should be displayed randomly.

This setting takes precedence over the Learning's same property.


API Tags:
Return:  True if questions should be random, false otherwise.
Access:  public


[ Top ]
getQuestionsRandomByDifficulty  [line 97]

  boolean getQuestionsRandomByDifficulty( )

Declares if the questions for this Learning Offering's quiz should be displayed randomly, but only randomly within increasing difficuly.

If true, first ask all difficutly 1 questions randomly, then difficutly 2 questions randomly, and so on in that fashion. This setting takes precedence over the Learning's same property.


API Tags:
Return:  True if questions should be random by difficutly, false otherwise.
Access:  public


[ Top ]
getStart  [line 39]

  string getStart( )

Returns the start date of the offering in the form "YYYY-MM-DD".


API Tags:
Return:  Date "YYYY-MM-DD".
Access:  public


[ Top ]
getTitle  [line 24]

  string getTitle( )

Returns the title of the Learning Offering.


API Tags:
Return:  Learning Offering title.
Access:  public


[ Top ]
setCourseOfferingId  [line 125]

  boolean setCourseOfferingId( integer $id  )

Sets the Id of the Course Offering this Learning Offering is part of.

Parameters:
integer   $id:  The id of the Course Offering this Learning is part of.

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setEnd  [line 66]

  boolean setEnd( $dateString $dateString  )

Sets the ending date of an offering.

Date must be passed in the format "YYYY-MM-DD".

Parameters:
$dateString   $dateString:  Date string in the format "YYYY-MM-DD"

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setLearningId  [line 140]

  boolean setLearningId( integer $id  )

Sets the Id of the Learning this Learning Offering is offering.

Parameters:
integer   $id:  The id of the Learning this Learning Offering is offering.

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setQuestionsRandom  [line 85]

  boolean setQuestionsRandom( boolean $bool  )

Sets if the questions for this Learning Offering's quiz should be displayed randomly.

This setting takes precedence over the Learning's same property.

Parameters:
boolean   $bool:  True if they should be random, false otherwise.

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setQuestionsRandomByDifficulty  [line 110]

  boolean setQuestionsRandomByDifficulty( boolean $bool  )

Sets if the questions for this Learning Offering's quiz should be displayed randomly by difficutly.

If true, first ask all difficutly 1 questions randomly, then difficutly 2 questions randomly, and so on in that fashion. This setting takes precedence over the Learning's same property.

Parameters:
boolean   $bool:  True if they should be random by difficulty, false otherwise.

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setStart  [line 49]

  boolean setStart( $dateString $dateString  )

Sets the starting date of an offering.

Date must be passed in the format "YYYY-MM-DD".

Parameters:
$dateString   $dateString:  Date string in the format "YYYY-MM-DD"

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]
setTitle  [line 32]

  boolean setTitle( string $title  )

Sets the title of the Learning Offering

Parameters:
string   $title:  The title of the Learning Offering.

API Tags:
Return:  True on success, false otherwise.
Access:  public


[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:18:06 -0500 by phpDocumentor 1.3.0