eval_template

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

An element of type "eval_template" represents a template for an evaluation. Basically it controls the set of items and the ordering and layout of an evaluation. This is like the original of a paper survey.

An "eval_template" element contains nine other elements to provide property values for the eval_template. 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 TYPE with a value of type string255
  • An element named DESCRIPTION with a value of type xsd:string
  • An element named SHARING with a value of type results_sharing
  • An element named EXPERT with a value of type xsd:boolean
  • An element named EXPERT_DESCRIPTION with a value of type xsd:string
  • An optional element named LOCKED with a value of type xsd:boolean

The full definition of the "eval_template" type is:

<xsd:complexType name="eval_template">
	<xsd:annotation>
		<xsd:documentation xml:lang="en">
			<p>This represents a template for an evaluation. Basically it controls the set of
				items and the ordering and layout of an evaluation. This is like the original of
				a paper survey.</p>
			<p>When importing a template that already exists in the system (i.e. it has the same
				EID), the entire template will be replaced with supplied values. Template Item
				changes will only be applied to evaluations that are imported subsequent to the
				change. All previous evaluations (and their associated template copies) will
				remain unchanged. </p>
		</xsd:documentation>
		<xsd:appinfo>
			<jaxb:class name="EvalTemplate"
				implClass="org.sakaiproject.evaluation.model.EvalTemplate"/>
		</xsd:appinfo>
	</xsd:annotation>
	<xsd:all>
		<xsd:element name="EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifier for this template. </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 template. </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
					template. </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="TYPE" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The type indicates whether this is a standard
					template or an added items template (for now). </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="DESCRIPTION" type="xsd:string">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The description that is displayed only when
					editing or selecting this template. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Change element name from
					"DESCR" to "description" </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="SHARING" type="results_sharing">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Sharing setting for this template (private,
					public, etc). </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: none </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="EXPERT" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Is this an expert-created template? </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="EXPERT_DESCRIPTION" type="xsd:string">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The expert description for use of this
					template. </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="LOCKED" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Locked templates cannot be edited or removed.
					Any template used in an evaluation must be locked also. </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:all>
</xsd:complexType>