eval_templateitem

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

An element of type "eval_templateitem" represents an item in a template. Effectively items are reusable and therefore this element indicates an instance of an item within a template. Ordering and layout details are specified here.

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

  • An element named EID with a value of type string255
  • An element named OWNER with a value of type string255
  • An element named TEMPLATE_EID with a value of type string255
  • An element named ITEM_EID with a value of type string255
  • An element named DISPLAY_ORDER with a value of type xsd:int
  • An element named CATEGORY with a value of type string255
  • An element named HEIRARCHY_LEVEL with a value of type string255
  • An element named HEIRARCHY_NODE_ID with a value of type string255
  • An element named DISPLAY_ROWS with a value of type xsd:int
  • An element named SCALE_DISPLAY_SETTING with a value of type string255
  • An element named USES_NA with a value of type xsd:boolean
  • An element named BLOCK_PARENT with a value of type xsd:boolean
  • An element named BLOCK_EID with a value of type string255
  • An element named RESULTS_SHARING with a value of type results_sharing

The full definition of the "eval_templateitem" type is:

<xsd:complexType name="eval_templateitem">
	<xsd:annotation>
		<xsd:documentation xml:lang="en"> This is an item in a template. Effectively items are
			reusable and therefore this is here to indicate an instance of an item within a
			template, ordering and layout details are specified here. </xsd:documentation>
		<xsd:appinfo>
			<jaxb:class name="EvalTemplateItem"
				implClass="org.sakaiproject.evaluation.model.EvalTemplateItem"/>
		</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
					item. </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 item.</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="TEMPLATE_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifier for the template to
					which this item is being assigned. </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="ITEM_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifier for the item that is
					being added to the 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="DISPLAY_ORDER" type="xsd:int">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Stores the display order of items in the
					linked template. </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: integers from 1 up to (and
					including) the number of items in the list. 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="CATEGORY" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Used to determine the category of the item
					(course, instructor, etc). </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: String value. Maximum 255
					characters. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Change name from
					"ITEM_CATEGORY" to "category" </xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="HIERARCHY_LEVEL" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The hierarchy level of this template item
					(e.g. instructor, course, college). </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="HIERARCHY_NODE_ID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> This is the unique id of the hierarchy node
					this template item is at. </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="DISPLAY_ROWS" type="xsd:int">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> How big should the text box be when rendering
					this item? </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="SCALE_DISPLAY_SETTING" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> How should the item be rendered? </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="USES_NA" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Should this item include "Not Available" as an
					answer? </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="BLOCK_PARENT" type="xsd:boolean">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> Is this item the parent item for a block? </xsd:documentation>
				<xsd:documentation xml:lang="en"> Acceptable values: "true" or "false" or "1" or
					"0" (without quotes). A value is required. </xsd:documentation>
				<xsd:documentation xml:lang="en"> UMICH changes: Ensure that a value is
					supplied. A value is required.</xsd:documentation>
			</xsd:annotation>
		</xsd:element>
		<xsd:element name="BLOCK_EID" type="string255">
			<xsd:annotation>
				<xsd:documentation xml:lang="en"> The external identifier for the parent item of
					block containing this item. </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:all>
</xsd:complexType>