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

Interface: KuoteInterfaces_ResultSet

Source Location: /classes/KuoteInterfaces/ResultSet.php

Interface KuoteInterfaces_ResultSet

Interface Overview

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

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



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

Methods

[ Top ]
Method Summary
float   getAverage()   Returns the average grade of all results as a percent.
integer   getByCourseId()   Populates the ResultSet with all Results pertaining to the given course.
integer   getByCourseOfferingId()   Populates the ResultSet with all Results pertaining to the given course offering.
integer   getByLearningId()   Populates the ResultSet with all Results pertaining to the given learning quiz.
integer   getByLearningOfferingId()   Populates the ResultSet with all Results pertaining to the given learning offering's quiz.
integer   getByUserIdAndCourseOfferingId()   Populates the ResultSet with all Results pertaining to the given user and course offering.

[ Top ]
Methods
getAverage  [line 66]

  float getAverage( )

Returns the average grade of all results as a percent.


API Tags:
Return:  Grade average.
Access:  public


[ Top ]
getByCourseId  [line 42]

  integer getByCourseId( integer $id  )

Populates the ResultSet with all Results pertaining to the given course.

Parameters:
integer   $id:  The Id of the Course whose results we are to find.

API Tags:
Return:  Number of questions found
Access:  public


[ Top ]
getByCourseOfferingId  [line 50]

  integer getByCourseOfferingId( integer $id  )

Populates the ResultSet with all Results pertaining to the given course offering.

Parameters:
integer   $id:  The Id of the CourseOffering whose results we are to find.

API Tags:
Return:  Number of questions found
Access:  public


[ Top ]
getByLearningId  [line 25]

  integer getByLearningId( integer $id  )

Populates the ResultSet with all Results pertaining to the given learning quiz.

Parameters:
integer   $id:  The Id of the Learning whose questions to find.

API Tags:
Return:  Number of results found
Access:  public


[ Top ]
getByLearningOfferingId  [line 34]

  integer getByLearningOfferingId( integer $id  )

Populates the ResultSet with all Results pertaining to the given learning offering's quiz.

Parameters:
integer   $id:  The Id of the Learning Offering whose results we are to find.

API Tags:
Return:  Number of results found
Access:  public


[ Top ]
getByUserIdAndCourseOfferingId  [line 59]

  integer getByUserIdAndCourseOfferingId( integer $userId, integer $courseOfferingId  )

Populates the ResultSet with all Results pertaining to the given user and course offering.

Parameters:
integer   $userId:  The Id of the User whose results we are to find.
integer   $courseOfferingId:  The Id of the Course Offering whose results we are to find.

API Tags:
Return:  Number of questions found
Access:  public


[ Top ]

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