Interface: KuoteInterfaces_Result

Source Location: /classes/KuoteInterfaces/Result.php

Interface KuoteInterfaces_Result

Interface Overview

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

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

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Methods

[ Top ]

Method Summary

integer	getCorrectQuestionsCount()	Returns the number of questions answered correctly.
integer	getCourseId()	Returns the Id of the Result's Course
integer	getCourseOfferingId()	Returns the Id of the Result's Course Offering
integer	getLearningId()	Returns the Id of the Result's Learning
integer	getLearningOfferingId()	Returns the Id of the Result's Learning Offering
int	getLearningOfferingTakenId()	Returns the Id of the Learning Offer Taken for this result.
integer	getQuestionsCount()	Returns the total number of questions.
string	getTimestamp()	Returns the timestamp of when the Result was created or last modified.
int	getUserId()	Returns the unique user id of the student who took the quiz.
boolean	incrementCorrectQuestionsCount()	Returns the number of questions answered correctly.
boolean	setCorrectQuestionsCount()	Sets the number of questions answered correctly.
boolean	setCourseId()	Sets the Id of the Result's Course
boolean	setCourseOfferingId()	Sets the Id of the Result's Course Offering
boolean	setLearningId()	Sets the Id of the Result's Learning
boolean	setLearningOfferingId()	Sets the Id of the Result's Learning Offering
boolean	setLearningOfferingTakenId()	Sets the Id of the Learning Offer Taken for this result.
boolean	setQuestionsCount()	Sets the total number of questions.
boolean	setUserId()	Sets the unique user id of the student who took the quiz.

[ Top ]

Methods

getCorrectQuestionsCount [line 31]

integer getCorrectQuestionsCount(
)

Returns the number of questions answered correctly.

API Tags:

Return:	The number of questions answered correctly.
Access:	public

[ Top ]

getCourseId [line 98]

integer getCourseId(
)

Returns the Id of the Result's Course

API Tags:

Return:	Course Id
Access:	public

[ Top ]

getCourseOfferingId [line 113]

integer getCourseOfferingId(
)

Returns the Id of the Result's Course Offering

API Tags:

Return:	Course Offering Id
Access:	public

[ Top ]

getLearningId [line 68]

integer getLearningId(
)

Returns the Id of the Result's Learning

API Tags:

Return:	Learning Id
Access:	public

[ Top ]

getLearningOfferingId [line 83]

integer getLearningOfferingId(
)

Returns the Id of the Result's Learning Offering

API Tags:

Return:	Learning Offering Id
Access:	public

[ Top ]

getLearningOfferingTakenId [line 143]

int getLearningOfferingTakenId(
)

Returns the Id of the Learning Offer Taken for this result.

API Tags:

Return:	User Id.
Access:	public

[ Top ]

getQuestionsCount [line 46]

integer getQuestionsCount(
)

Returns the total number of questions.

API Tags:

Return:	The number of questions answered correctly.
Access:	public

[ Top ]

getTimestamp [line 61]

string getTimestamp(
)

Returns the timestamp of when the Result was created or last modified.

API Tags:

Return:	Timestamp.
Access:	public

[ Top ]

getUserId [line 128]

int getUserId(
)

Returns the unique user id of the student who took the quiz.

API Tags:

Return:	User Id.
Access:	public

[ Top ]

incrementCorrectQuestionsCount [line 24]

boolean incrementCorrectQuestionsCount(
)

Returns the number of questions answered correctly.

API Tags:

Return:	True on successful increment, False otherwise.
Access:	public

[ Top ]

setCorrectQuestionsCount [line 39]

boolean setCorrectQuestionsCount(
integer
$numberCorrect 
)

Sets the number of questions answered correctly.

Parameters:

integer

$numberCorrect:

The number of correctly answered questions.

API Tags:

Return:	True if successful, false if not.
Access:	public

[ Top ]

setCourseId [line 106]

boolean setCourseId(
integer
$id 
)

Sets the Id of the Result's Course

Parameters:

integer

$id:

Course Id

API Tags:

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

[ Top ]

setCourseOfferingId [line 121]

boolean setCourseOfferingId(
integer
$id 
)

Sets the Id of the Result's Course Offering

Parameters:

integer

$id:

Course Offering Id

API Tags:

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

[ Top ]

setLearningId [line 76]

boolean setLearningId(
integer
$id 
)

Sets the Id of the Result's Learning

Parameters:

integer

$id:

Learning Id

API Tags:

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

[ Top ]

setLearningOfferingId [line 91]

boolean setLearningOfferingId(
integer
$id 
)

Sets the Id of the Result's Learning Offering

Parameters:

integer

$id:

Learning Offering Id

API Tags:

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

[ Top ]

setLearningOfferingTakenId [line 151]

boolean setLearningOfferingTakenId(
integer
$id 
)

Sets the Id of the Learning Offer Taken for this result.

Parameters:

integer

$id:

User Id of the Course Creator.

API Tags:

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

[ Top ]

setQuestionsCount [line 54]

boolean setQuestionsCount(
integer
$count 
)

Sets the total number of questions.

Parameters:

integer

$count:

The number of correctly answered questions.

API Tags:

Return:	True if successful, false if not.
Access:	public

[ Top ]

setUserId [line 136]

boolean setUserId(
integer
$id 
)

Sets the unique user id of the student who took the quiz.

Parameters:

integer

$id:

User Id of the Course Creator.

API Tags:

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

[ Top ]

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

	KuoteInterfaces Object

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