eval_evaluation

Owned by Former user (Deleted)
Last updated: Sept 12, 2009Version comment
5 min read

An element of type "eval_evaluation" defines an actual evaluation that can be taken by students to assess instructors or classes.

An "eval_evaluation" element contains 28 other elements to provide property values for the eval_evaluation. All of these elements are required:

  • An element named EID with a value of type string255
  • An element named TITLE with a value of type string255
  • An element named OWNER with a value of type string255
  • An element named START_DATE with a value of type xsd:dateTime
  • An element named DUE_DATE with a value of type xsd:dateTime
  • An element named STOP_DATE with a value of type xsd:dateTime
  • An element named VIEW_DATE with a value of type xsd:dateTime
  • An element named STUDENT_VIEW_RESULTS with a value of type xsd:boolean
  • An element named INSTRUCTOR_VIEW_RESULTS with a value of type xsd:boolean
  • An element named STUDENT_VIEW_DATE with a value of type xsd:dateTime
  • An element named INSTRUCTOR_VIEW_DATE with a value of type xsd:dateTime
  • An element named STUDENTS_DATE with a value of type xsd:dateTime
  • An element named INSTRUCTORS_DATE with a value of type xsd:dateTime
  • An element named TEMPLATE_EID with a value of type string255
  • An element named INSTRUCTIONS with a value of type xsd:string
  • An element named INSTRUCTOR_OPT with a value of type string255
  • An element named REMINDER_DAYS with a value of type xsd:int
  • An element named REMINDER_FROM_EMAIL with a value of type string255
  • An element named TERM_ID with a value of type string255
  • An element named AUTH_CONTROL with a value of type string255
  • An element named EVAL_CATEGORY with a value of type string255
  • An element named RESULTS_SHARING with a value of type results_sharing
  • An element named BLANK_RESPONSES_ALLOWED with a value of type xsd:boolean
  • An element named MODIFY_RESPONSES_ALLOWED with a value of type xsd:boolean
  • An element named LOCKED with a value of type xsd:boolean
  • An element named UNREGISTERED_ALLOWED with a value of type xsd:boolean
  • An element named AVAILABLE_EMAIL_TEMPLATE_EID with a value of type string255
  • An element named REMINDER_EMAIL_TEMPLATE_EID with a value of type string255

The full definition of the "eval_evaluation" type is:

<xsd:complexType name="eval_evaluation">
	<xsd:annotation>
		<xsd:documentation xml:lang="en"> Defines an evaluation itself (this is an instance
			which can be taken by evaluators) </xsd:documentation>
		<xsd:appinfo>
			<jaxb:class name="EvalEvaluation"
				implClass="org.sakaiproject.evaluation.model.EvalEvaluation"/>
		</xsd:appinfo>
	</xsd:annotation>
	<xsd:all>
		<xsd:element name="EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifier for this evaluation. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="TITLE" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The display title for this evaluation. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="OWNER" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The internal identifier for the owner of this
					evaluation. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="START_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This is the date at which the evaluation
					becomes active. Evaluators can complete the evaluation after this date.
					Dates in the past will default to the current date. When updating an
					existing evaluation, the Start Date cannot be changed to a later time once
					an eval has opened. </xsd:documentation>
				<xsd:documentation>Acceptable Values: Dates in format specified by <a
						target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
						>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
				</xsd:documentation>
				<xsd:documentation> UMICH changes: Must change to dateTime format.
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="DUE_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This is the ending date for the evaluation.
					This cannot be set to a date before the Start Date. If this is null (i.e. no
					due_date value is provided), there is no due date and the evaluation is open
					until it is manually closed. Dates in the past will default to the current
					date. Whether this date is used depends on the "useDueDate" setting.
						<xsd:documentation>Acceptable Values: Dates in format specified by <a
							target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
							>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
					</xsd:documentation>
					<xsd:documentation> UMICH changes: Must change to dateTime format.
					</xsd:documentation>
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="STOP_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This defines the grace period for completing
					the evaluation after the due date. This cannot be set to a date before the
					Start Date. If this is not set, there is no grace period. Whether this date
					is used depends on the "useStopDate" setting. </xsd:documentation>
				<xsd:documentation>Acceptable Values: Dates in format specified by <a
						target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
						>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
				</xsd:documentation>
				<xsd:documentation> UMICH changes: Must change to dateTime format.
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="VIEW_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This defines the overall view date for this
					evaluation, trumping the students and instructors dates. If this is not set,
					the results are immediately viewable after the evaluation closes. The
					students and instructors dates must be later than the view date or they will
					have no effect. </xsd:documentation>
				<xsd:documentation>Acceptable Values: Dates in format specified by <a
						target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
						>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
				</xsd:documentation>
				<xsd:documentation> UMICH changes: Must change to dateTime format.
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="STUDENT_VIEW_RESULTS" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If this is true, students can view results for
					this evaluation. If set to false, the "studentsDate" will be nulled out when
					the evaluation is saved. Default value is false if not set. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied.</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="INSTRUCTOR_VIEW_RESULTS" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If this is true, instructors can view results
					for this evaluation. If set to false, the "instructorsDate" will be nulled
					out when the evaluation is saved. Default value is false if not set. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied. </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="STUDENTS_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If "studentViewResults" is true and this is
					null, students can view results as soon as the evaluation is closed.
					Otherwise they can view results after this date. </xsd:documentation>
				<xsd:documentation>Acceptable Values: Dates in format specified by <a
						target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
						>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
				</xsd:documentation>
				<xsd:documentation> UMICH changes: Must change to dateTime format.
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="INSTRUCTORS_DATE" type="xsd:dateTime">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If "instructorViewResults" is true and this is
					null, instructors can view results as soon as the evaluation is closed.
					Otherwise they can view results after this date. </xsd:documentation>
				<xsd:documentation>Acceptable Values: Dates in format specified by <a
						target="_blank" href="http://www.w3.org/TR/xmlschema11-2/#dateTime"
						>http://www.w3.org/TR/xmlschema11-2/#dateTime</a>
				</xsd:documentation>
				<xsd:documentation> UMICH changes: Must change to dateTime format.
				</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="TEMPLATE_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This is the external identifier that uniquely
					identifies an existing template to be associated with this evaluation. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="INSTRUCTIONS" type="xsd:string">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="INSTRUCTOR_OPT" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="REMINDER_DAYS" type="xsd:int">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The number of days between reminder emails.
					Zero (0) or null means emails are disabled, and -1 means send them out once,
					24 hours before the close. This value will be ignored if the administrator
					indicates that the system-wide value should be used instead. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: integers (small values). A
					valid numeric value is required. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="REMINDER_FROM_EMAIL" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The email address that notification emails
					should be sent from for this evaluation. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="TERM_ID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="AUTH_CONTROL" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="EVAL_CATEGORY" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="RESULTS_SHARING" type="results_sharing">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Defines the sharing of results related to this
					item (e.g. public, private). </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: One of "private",
					"visible", "shared" or "public" (see "results_sharing" type). </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: ensure that a valid response is
					used. </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="BLANK_RESPONSES_ALLOWED" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If true, blank responses are allowed.
					Otherwise, all answers must be completed. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="MODIFY_RESPONSES_ALLOWED" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> If true, responses may be changed during
					active eval period. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied. </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="LOCKED" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied. </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="UNREGISTERED_ALLOWED" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes) </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied. </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="AVAILABLE_EMAIL_TEMPLATE_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifer for the "available"
					email template to use for this evaluation. If null, use the default email
					template (see EvalConstants#EMAIL_TEMPLATE_AVAILABLE). </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="REMINDER_EMAIL_TEMPLATE_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifer for the "reminder"
					email template to use for this evaluation. If null, use the default email
					template (see EvalConstants#EMAIL_TEMPLATE_REMINDER). </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
	</xsd:all>
</xsd:complexType>