--
-- Assessment Package
--
-- @author eperez@it.uc3m.es
-- @creation-date 2004-07-20
--

--Section Display Types: define types of display for an groups of Items.
create table as_section_display_types (
	display_type_id		integer
				constraint as_section_display_types_id_pk
				primary key
				constraint as_section_display_types_id_fk
				references cr_revisions(revision_id)
                on delete cascade,
	-- number of items displayed per page
	num_items		integer,
	-- adp template
	adp_chunk		text,
	-- whether this Section defines a branch point or whether this Section simply transitions to the next Section
	branched_p		char(1) default 'f'
				constraint as_section_display_types_branched_p_ck
				check (branched_p in ('t','f')),
	-- whether the back button is not allowed to work
	back_button_p		char(1) default 't'
				constraint as_section_display_types_back_button_p_ck
				check (back_button_p in ('t','f')),
	-- whether each answer has to be submitted via a separate button
	submit_answer_p		char(1) default 'f'
				constraint as_section_display_types_submit_answer_p_ck
				check (submit_answer_p in ('t','f')),
	-- order in which the items will appear (randomized, alphabetical, order_of_entry)
	sort_order_type		varchar(20)
);

-- Sections: represents logically-grouped set of items 
create table as_sections (
	section_id	integer
			constraint as_sections_section_id_pk
			primary key
			constraint as_sections_section_id_fk
			references cr_revisions(revision_id)
            on delete cascade,
	display_type_id	integer
			constraint as_sections_display_type_id_fk
			references as_section_display_types (display_type_id)
            on delete cascade,
	-- text displayed on user pages
	instructions	text,
	-- number of items displayed
	num_items	integer,
	-- number of points for section; might be used for defining difficulty levels
	points		float,
	-- preset text to show user
	feedback_text	text,
	-- max number of seconds to perform Section
	max_time_to_complete	integer
);

-- Are the highest-level container in the hierarchical structure
-- They define the key by which all other entities are assembled into meaningful order during:
-- display, processing and retrieval of Assessment information
create table as_assessments (
	-- A revision_id inherited from cr_revisions
	assessment_id	integer
			constraint as_assessments_assessment_id_pk
			primary key
			constraint as_assessments_assessment_id_fk
			references cr_revisions(revision_id)
            on delete cascade,
	-- who is the "main" author and creator of this assessment
	creator_id integer,
	-- text that explains any specific steps the subject needs to follow
	instructions	text,
	-- whether this is a standalone assessment (like current surveys), or if it provides an "assessment service" to another OpenACS app, or a "web service" via SOAP, etc
	run_mode	varchar(25),
	-- whether the creator of the assessment will have the possibility to see the personal details of the respondee or not 
	anonymous_p	char(1) default 'f'
			constraint as_assessments_anonymous_p_ck
			check (anonymous_p in ('t','f')),
	-- whether the assessment can only be taken if a secure connection (https) is used
	secure_access_p	char(1) default 'f'
			constraint as_assessments_secure_access_p_ck
			check (secure_access_p in ('t','f')),
	-- whether an assessment can reuse responses		
	reuse_responses_p	char(1) default 'f'
			constraint as_assessments_reuse_responses_p_ck
			check (reuse_responses_p in ('t','f')),
	-- whether the name of the item is shown
	show_item_name_p	char(1) default 'f'
			constraint as_assessments_show_item_name_p_ck
			check (show_item_name_p in ('t','f')),
	-- whether the order of section, items, choices can be random
	random_p	char(1) default 't'
			constraint as_assessments_random_p_ck
			check (random_p in ('t','f')),
	-- the customizable entry page that will be displayed before the first response.
	entry_page varchar(4000),
	-- customizable exit / thank you page that will be displayed once the assessment has been responded.
	exit_page varchar(4000),
	consent_page text,
	-- URL the respondee will be redirected to after finishing the assessment
	return_url varchar(200),
	-- at what time shall the assessment become available to the users 
	start_time timestamptz,
	-- at what time the assessment becomes unavailable
	end_time timestamptz,
	-- number of times a respondee can answer the assessment
	number_tries integer,
	-- number of minutes a respondee has to wait before he can retake the assessment
	wait_between_tries integer,
	-- how many minutes has the respondee to finish the assessment
	time_for_response integer,
	-- ip mask for restricted access
	ip_mask varchar(100),
	-- password for restricted access
	password varchar(100),
	-- the feedback type which will be displayed to the respondee (all, none, correct, incorrect)
	show_feedback varchar(50) default 'all'
			constraint as_assessments_show_feedback_ck
			check (show_feedback in ('none', 'all', 'incorrect', 'correct')),
	-- how shall the navigation happen (default path, randomized, rule-based branching)
	section_navigation varchar(50) default 'default path'
			constraint as_assessments_section_navigation_ck
			check (section_navigation in ('default path', 'randomized', 'rule-based branching')),
	-- differentiate between an assessment and a survey
	survey_p 	char(1) default 'f'
			constraint as_assessments_survey_p_ck
			check (survey_p in ('t', 'f')),
	type		varchar(1000)
);

-- Style Options 
-- Each assessment has a special style associated with it. As styles can be reused.
create table as_assessment_styles (
       -- custom header that will be displayed to the respondee when answering an assessment. 
       custom_header	varchar(500), 
       -- custom footer that will be displayed to the respondee when answering an assessment.
       custom_footer	varchar(500), 
       -- style (form_template) that will be used for this assessment. 
       form_template	varchar(500),
       -- what kind of progress bar shall be displayed to the respondee while taking the assessment
       progress_bar 	varchar(20) default 'no'       
			constraint as_assessment_styles_progress_bar_ck
			check (progress_bar in ('no','blue','red','green', 'yellow')),
       -- select a presentation style (all question at once, one question per page, sectioned)
       presentation_style 	varchar(20) default 'all'
       			constraint as_assessment_styles_presentation_style_ck
			check (presentation_style in ('all', 'one', 'sectioned')) 
);

-- Section Assessment Map: defines the sections of an assessment
create table as_assessment_section_map (
	assessment_id	integer
			constraint as_assessment_section_map_assessment_id_fk
			references as_assessments (assessment_id)
            on delete cascade,
	section_id	integer
			constraint as_assessment_section_map_section_id_fk
			references as_sections (section_id)
            on delete cascade,
	-- maximum time to complete a section
	max_time_to_complete	integer,
	-- order in which a section will be displayed
	sort_order	integer,
	-- this is the relative weight of a section in an assessment
	points		float,
	constraint as_assessment_section_map_pk primary key (assessment_id, section_id)
);

create unique index as_assessment_section_map_pk2 on as_assessment_section_map (section_id, assessment_id);
create index as_assessment_section_map_sort_order_idx on as_assessment_section_map (assessment_id, sort_order);

-- Item Section Map: defines the items of a section
create table as_item_section_map (
	as_item_id	integer
			constraint as_item_section_map_item_id_fk
			references as_items (as_item_id)
            on delete cascade,
	section_id	integer
			constraint as_item_section_map_section_id_fk
			references as_sections (section_id)
            on delete cascade,
	-- whether Item must be answered
	required_p	char(1) default 'f'
			constraint as_item_section_map_required_p_ck
			check (required_p in ('t','f')),
	-- maximum time to answer the item
	max_time_to_complete	integer,
	-- order in which items appear in a section
	sort_order	integer,
	-- fixed position in display. 0 for default, negative values relative to section end
	fixed_position	integer,
	-- this is the relative weight of an item in a section
	points		float,
	constraint as_item_section_map_pk primary key (section_id, as_item_id)
);

create unique index as_item_section_map_pk2 on as_item_section_map (as_item_id, section_id);
create index as_item_section_map_sort_order_idx on as_item_section_map (section_id, sort_order);