Interface: KuoteInterfaces_QuestionAnswered

Source Location: /classes/KuoteInterfaces/QuestionAnswered.php

Interface KuoteInterfaces_QuestionAnswered

Interface Overview

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

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

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Methods

[ Top ]

Method Summary

integer	getChoice()	Returns the selected choice of the questions answer options
boolean	getIsCorrect()	Returns true if the selected answer is correct.
integer	getLearningOfferTakenId()	Returns the Id of the LearningOfferTaken for the quiz of the question this QuestionAnswered is answering.
integer	getQuestionId()	Returns the Id of the Question this QuestionAnswered is answering.
boolean	initialize()	Creates a new QuestionAnswered in the datastore based on the given Question Id and LearningOfferTaken Id.
boolean	setChoice()	Sets the selected choice of the questions answer options
boolean	setIsCorrect()	Sets whether the selected answer is correct or not.
boolean	setLearningOfferTakenId()	Sets the Id of the LearningOfferTaken for the quiz of the question
boolean	setQuestionId()	Sets the Id of the Question this QuestionAnswered is answering.

[ Top ]

Methods

getChoice [line 34]

integer getChoice(
)

Returns the selected choice of the questions answer options

API Tags:

Return:	Question Option.
Access:	public

[ Top ]

getIsCorrect [line 49]

boolean getIsCorrect(
)

Returns true if the selected answer is correct.

API Tags:

Return:	True if selected answer is correct, false otherwise.
Access:	public

[ Top ]

getLearningOfferTakenId [line 80]

integer getLearningOfferTakenId(
)

Returns the Id of the LearningOfferTaken for the quiz of the question this QuestionAnswered is answering.

API Tags:

Return:	LearningOfferTaken Id
Access:	public

[ Top ]

getQuestionId [line 64]

integer getQuestionId(
)

Returns the Id of the Question this QuestionAnswered is answering.

API Tags:

Return:	Question Id
Access:	public

[ Top ]

initialize [line 27]

boolean initialize(
KuoteObjects_Question
$question, KuoteObjects_LearningOfferTaken
$learningOfferTaken 
)

Creates a new QuestionAnswered in the datastore based on the given Question Id and LearningOfferTaken Id.

Parameters:

KuoteObjects_Question	$question:	The Question being answered.
KuoteObjects_LearningOfferTaken	$learningOfferTaken:	The LearningOfferTaken for this quiz.

API Tags:

Return:	True if created successfully, false otherwise.
Access:	public

[ Top ]

setChoice [line 42]

boolean setChoice(
integer
$choice 
)

Sets the selected choice of the questions answer options

Parameters:

integer

$choice:

Question Option.

API Tags:

Return:	True on successful set, false otherwise.
Access:	public

[ Top ]

setIsCorrect [line 57]

boolean setIsCorrect(
boolean
$bool 
)

Sets whether the selected answer is correct or not.

Parameters:

boolean

$bool:

True if correct, otherwise False

API Tags:

Return:	True on successful set, false otherwise.
Access:	public

[ Top ]

setLearningOfferTakenId [line 88]

boolean setLearningOfferTakenId(
integer
$id 
)

Sets the Id of the LearningOfferTaken for the quiz of the question

Parameters:

integer

$id:

LearningOfferTaken Id

API Tags:

Return:	True on successful set, false otherwise.
Access:	public

[ Top ]

setQuestionId [line 72]

boolean setQuestionId(
integer
$id 
)

Sets the Id of the Question this QuestionAnswered is answering.

Parameters:

integer

$id:

Question Id

API Tags:

Return:	True on successful set, false otherwise.
Access:	public

[ Top ]

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

	KuoteInterfaces Object

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