Database Storage Engine Project M2 API - Revision history

MrP at 12:05, 11 August 2010

2010-08-11T12:05:38Z

← Older revision		Revision as of 14:05, 11 August 2010
Line 265:		Line 265:
	Moves the model answer one place to the end of the question.		Moves the model answer one place to the end of the question.

	=== void reorder(assoc(modelAnswerId => orderNumber))===		=== void <nowiki>reorder(assoc(modelAnswerId => orderNumber))</nowiki>===

	Changes the order of the given model answers to the given order numbers. O6rders must be unique. When there are clashes, an exception will be thrown (defined later).		Changes the order of the given model answers to the given order numbers. O6rders must be unique. When there are clashes, an exception will be thrown (defined later).
Line 419:		Line 419:
	Moves the question one place to the end of the section.		Moves the question one place to the end of the section.

	=== void reorder(assoc(questionID => orderNumber))===		=== void <nowiki>reorder(assoc(questionID => orderNumber))</nowiki>===

	Changes the order of the given questions to the given order numbers. Orders must be unique. When there are clashes, an exception will be thrown (defined later).		Changes the order of the given questions to the given order numbers. Orders must be unique. When there are clashes, an exception will be thrown (defined later).

MrP at 12:03, 11 August 2010

2010-08-11T12:03:10Z

Show changes

MrP at 10:05, 24 July 2010

2010-07-24T10:05:01Z

@@ Line 77: / Line 77: @@
 == QuestionType==
-A survey can have various types of questions, ranging from string & integers up to fileinput and matrix types. QuestionType will have subclasses: basic question types like IntegerQuestionType, StringQuestionType, DateQuestionType ... and structures like MatrixQuestionType, ArrayQuestionType, ...
+A survey can have various types of questions, ranging from string & integers up to fileinput and matrix types. Question types will have policies which will be implemented as special question types.
 === string render(DbseQuestion $question)===
@@ Line 98: / Line 98: @@
 Magic get method for the attributes.
 == Question==

MrP at 09:56, 24 July 2010

2010-07-24T09:56:46Z

← Older revision		Revision as of 11:56, 24 July 2010
Line 377:		Line 377:
	This controller provides methodes to store and retrieve survey answers.		This controller provides methodes to store and retrieve survey answers.

	=== void addResponse(surveyID, participantID, questionID, value, starttime, endtime, iteration=0)===		=== void addResponse($surveyID, $participantID, $questionID, $value, $starttime, $endtime, $iteration=0)===

	Adds the given answer and metadata for the given question to the answers of the given participant. If there already was an answer to the given question for the given participant, the answer will be overridden. The iteration parameter is used to express this is the answer for the i'th loop. If the given answer value is invalid for the given question, an exception will be thrown.		Adds the given answer and metadata for the given question to the answers of the given participant. If there already was an answer to the given question for the given participant, the answer will be overridden. The iteration parameter is used to express this is the answer for the i'th loop. If the given answer value is invalid for the given question, an exception will be thrown.

	=== Response getResponse(surveyID, participantID, questionID)===		=== Response[] getResponse($surveyID, $participantID, $questionID)===

	Returns the ~~response~~ of the given participant to the given question and its metadata.		Returns the responses of the given participant to the given question and its metadata. Can be more than one response since there might be multiple iterations.

	=== Response[] getResponsesToQuestion(surveyID, questionID)===		=== Response[] getResponsesOfParticipant($surveyID, $participant_id)===

			Returns a list of all answers by the participant to the survey.

			=== Response[] getResponsesToQuestion($surveyID, $questionID)===

	Returns all responses to the given question and their metadata.		Returns all responses to the given question and their metadata.

	=== Response[] getResponses(surveyID)===		=== Response[] getResponses($surveyID)===

	Returns all responses to the survey.		Returns all responses to the survey.

	=== mixed exportResponses(surveyID)===		=== mixed exportResponses($surveyID)===

	Returns a double array containing all response information from the survey.		Returns a double string array containing all response information from the survey.

	=== boolean hasFinished(surveyID, participantID)===		=== boolean hasFinished($surveyID, $participantID)===

	Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.		Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.

	~~=== date getSurveyStart(surveyID, participantID)===~~

	~~Returns the start time of this participant.~~

	~~=== date getSurveyEnd(surveyID, participantID)===~~

	~~Returns the end time of this participant.~~

	~~=== assoc(section_id => date) getSectionStart(surveyID, participantID)===~~

	~~Returns the start times of this participant for each section.~~

	~~=== assoc(section_id => date) getSectionEnd(surveyID, participantID)===~~

	~~Returns the end times of this participant for each section.~~

	== ObserverController==		== ObserverController==
Line 423:		Line 411:
	Returns a statical instance to the ObserverController.		Returns a statical instance to the ObserverController.

	=== void addObserver(DBSEObserver observer)===		=== void addObserver(DBSEObserver $observer)===

	Adds an observer to the ObserverController.		Adds an observer to the ObserverController.

	=== void removeObserver(DBSEObserver observer)===		=== void removeObserver(DBSEObserver $observer)===

	Removes an observer from the ObserverController.		Removes an observer from the ObserverController.

	=== void notifyObservers(callback $function ~~~091~~~, ~~mixed~~ $parameter ~~~091~, mixed $... ~093<span style="color:093~~~)===		=== void notifyObservers(callback $function, mixed $parameter)===

	Notifies all registered observers with the specific function and the given parameters.		Notifies all registered observers with the specific function and the given parameters.

	==Global notes==		==Global notes==
	*Metadata keys can be chained in dot-notation. 'color.red' means the key 'color' with subkey 'red'.		*Exceptions will be used for reporting errors. The exceptions thrown by each method will be added later in the development process. For a documentation on the thrown errors, see the code documentation.
	*The returning of subkeys in metadata will result in assocs in the array. The 'color.red' example will give"> array(color => array(red => ...)). When you use a subkey, you cannot use the key itself anymore.
	*Exceptions will be used for reporting errors. The exceptions thrown by each method will be added later in the development process.

	= Discussions=		= Discussions=

MrP at 09:51, 24 July 2010

2010-07-24T09:51:35Z

Show changes

MrP at 10:01, 10 July 2010

2010-07-10T10:01:04Z

MrP at 09:57, 10 July 2010

2010-07-10T09:57:07Z

← Older revision		Revision as of 11:57, 10 July 2010
Line 336:		Line 336:

	This controller provides methodes to store and retrieve survey answers.		This controller provides methodes to store and retrieve survey answers.

	~~=== '''construct(surveyID)===~~

	~~Constructs a new controller for the given survey.~~

	=== void addResponse(participantID, questionID, value, starttime, endtime, iteration=0)===		=== void addResponse(participantID, questionID, value, starttime, endtime, iteration=0)===
Line 353:		Line 349:
	Returns all responses to the given question and their metadata.		Returns all responses to the given question and their metadata.

	=== Response[] getResponses()===		=== Response[] getResponses(surveyID)===

	Returns all responses to the survey.		Returns all responses to the survey.

	=== mixed exportResponses()===		=== mixed exportResponses(surveyID)===

	Returns a double array containing all response information from the survey.		Returns a double array containing all response information from the survey.

	=== boolean hasFinished(participantID)===		=== boolean hasFinished(surveyID,participantID)===

	Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.		Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.

	=== date getSurveyStart(participantID)===		=== date getSurveyStart(surveyID,participantID)===

	Returns the start time of this participant.		Returns the start time of this participant.

	=== date getSurveyEnd(participantID)===		=== date getSurveyEnd(surveyID,participantID)===

	Returns the end time of this participant.		Returns the end time of this participant.

	=== assoc(section_id => date) getSectionStart(participantID)===		=== assoc(section_id => date) getSectionStart(surveyID,participantID)===

	Returns the start times of this participant for each section.		Returns the start times of this participant for each section.

	=== assoc(section_id => date) getSectionEnd(participantID)===		=== assoc(section_id => date) getSectionEnd(surveyID,participantID)===

	Returns the end times of this participant for each section.		Returns the end times of this participant for each section.

MrP at 09:17, 9 July 2010

2010-07-09T09:17:47Z

← Older revision		Revision as of 11:17, 9 July 2010
Line 79:		Line 79:
	A survey can have various types of questions, ranging from string & integers up to fileinput and matrix types. QuestionType will have subclasses: basic question types like IntegerQuestionType, StringQuestionType, DateQuestionType ... and structures like MatrixQuestionType, ArrayQuestionType, ...		A survey can have various types of questions, ranging from string & integers up to fileinput and matrix types. QuestionType will have subclasses: basic question types like IntegerQuestionType, StringQuestionType, DateQuestionType ... and structures like MatrixQuestionType, ArrayQuestionType, ...

	=== ~~abstract~~ string render()===		=== string render(Question)===

	Returns a template for this questiontype.		Returns a template for this questiontype.

	=== ~~abstract~~ mixed getFields()===		=== mixed getFields(Question)===

	Returns a list of all fields required by this questiontype and their types.		Returns a list of all fields required by this questiontype and their types.

	=== ~~abstract~~ bool checkResponse(value)===		=== bool checkResponse(Question, value)===

	Returns true if the given value is a valid response to the question.		Returns true if the given value is a valid response to the question.
Line 118:		Line 118:

	Removes the given metadata from the question.		Removes the given metadata from the question.

			=== string render(Question)===

			Returns a template for this question.

			=== mixed getFields(Question)===

			Returns a list of all fields required by this question and their types.

	=== bool checkResponse(value)===		=== bool checkResponse(value)===

MrP at 18:18, 2 July 2010

2010-07-02T18:18:37Z

← Older revision		Revision as of 20:18, 2 July 2010
Line 17:		Line 17:
	= Basic API version (06-25)=		= Basic API version (06-25)=

	Below you find ~~the first draft of~~ the API.		Below you find the API.

	== Survey==		== Survey==

MrP at 18:13, 2 July 2010

2010-07-02T18:13:12Z

← Older revision		Revision as of 20:13, 2 July 2010
Line 9:		Line 9:

	= Todo=		= Todo=
	*Develop basic API and post it on the forums		*Develop basic API and post it on the forums (done)
	*Explore comments on the basic API		*Explore comments on the basic API (done)
	*Complete the API		*Complete the API (done)
	*Make sure it is possible to add/have support for current en future metadata related to single <u>questions</u> & whole <u>surveys</u>.		*Make sure it is possible to add/have support for current en future metadata related to single <u>questions</u> & whole <u>surveys</u>. (done)
	*Add methods to add and remove observers		*Add methods to add and remove observers (done)

	= Basic API version (06-25)=		= Basic API version (06-25)=

← Older revision		Revision as of 12:01, 10 July 2010
Line 337:		Line 337:
	This controller provides methodes to store and retrieve survey answers.		This controller provides methodes to store and retrieve survey answers.

	=== void addResponse(participantID, questionID, value, starttime, endtime, iteration=0)===		=== void addResponse(surveyID, participantID, questionID, value, starttime, endtime, iteration=0)===

	Adds the given answer and metadata for the given question to the answers of the given participant. If there already was an answer to the given question for the given participant, the answer will be overridden. The iteration parameter is used to express this is the answer for the i'th loop. If the given answer value is invalid for the given question, an exception will be thrown.		Adds the given answer and metadata for the given question to the answers of the given participant. If there already was an answer to the given question for the given participant, the answer will be overridden. The iteration parameter is used to express this is the answer for the i'th loop. If the given answer value is invalid for the given question, an exception will be thrown.

	=== Response getResponse(participantID, questionID)===		=== Response getResponse(surveyID, participantID, questionID)===

	Returns the response of the given participant to the given question and its metadata.		Returns the response of the given participant to the given question and its metadata.

	=== Response[] getResponsesToQuestion(questionID)===		=== Response[] getResponsesToQuestion(surveyID, questionID)===

	Returns all responses to the given question and their metadata.		Returns all responses to the given question and their metadata.
Line 357:		Line 357:
	Returns a double array containing all response information from the survey.		Returns a double array containing all response information from the survey.

	=== boolean hasFinished(surveyID,participantID)===		=== boolean hasFinished(surveyID, participantID)===

	Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.		Returns true if the given participant already finished the survey. Returns false if the participant did not complete the survey.

	=== date getSurveyStart(surveyID,participantID)===		=== date getSurveyStart(surveyID, participantID)===

	Returns the start time of this participant.		Returns the start time of this participant.

	=== date getSurveyEnd(surveyID,participantID)===		=== date getSurveyEnd(surveyID, participantID)===

	Returns the end time of this participant.		Returns the end time of this participant.

	=== assoc(section_id => date) getSectionStart(surveyID,participantID)===		=== assoc(section_id => date) getSectionStart(surveyID, participantID)===

	Returns the start times of this participant for each section.		Returns the start times of this participant for each section.

	=== assoc(section_id => date) getSectionEnd(surveyID,participantID)===		=== assoc(section_id => date) getSectionEnd(surveyID, participantID)===

	Returns the end times of this participant for each section.		Returns the end times of this participant for each section.