Docs For Class Section

Class Section

Description

Section includes zero or more Items and can also contain other Sections.

The Items added to a Section are returned first in, first out (FIFO). Items can be ordered explicitly using the orderItems method. The Sections added to a Section are returned first in, first out (FIFO). Sections can be ordered explicitly using the orderSections method. SectionType is meaningful to an application and not specifcally defined in the OSID. The unique Id is set by the AssessmentManager's createSection method's implementation.

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/assessment/Section.php (line 24)

Method Summary

void addItem (mixed $item, object Item $item )

void addSection (mixed $section, object Section $section )

object mixed getData ()

string getDescription ()

string getDisplayName ()

object Id getId ()

object ItemIterator getItems ()

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object SectionIterator getSections ()

object Type getSectionType ()

void orderItems (mixed $items, object Item[] $items )

void orderSections (mixed $sections, object Section[] $sections )

void removeItem (mixed $itemId, object Id $itemId )

void removeSection (mixed $sectionId, object Id $sectionId )

void updateData (object mixed $data)

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

Methods

addItem (line 290)

Add an Item to this Section. The Items added to a Section are returned first in, first out (FIFO). Items can be ordered explicitly using the orderItems method.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, ALREADY_ADDED

void addItem (mixed $item, object Item $item )

object Item $item

addSection (line 402)

Add a Section to this Section. The Sections added to a Section are returned first in, first out (FIFO). Sections can be ordered explicitly using the orderSections method.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, ALREADY_ADDED

void addSection (mixed $section, object Section $section )

object Section $section

getData (line 215)

Get the Data for this Section. The structure of the Data is not defined in the OSID.

return: (original type: java.io.Serializable)
access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object mixed getData ()

getDescription (line 144)

Get the description for this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

getDisplayName (line 121)

Get the display name for this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

getId (line 167)

Get the unique Id for this Item.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

getItems (line 342)

Get all the Items in this Section. The Items added to a Section are returned first in, first out (FIFO). Items can be ordered explicitly using the orderItems method. Only the Items directly associated with this Section are returned.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object ItemIterator getItems ()

getProperties (line 261)

Get the Properties associated with this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PropertiesIterator getProperties ()

getPropertiesByType (line 514)

Get the Properties of this Type associated with this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

getPropertyTypes (line 238)

Get all the Property Types for Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getPropertyTypes ()

getSections (line 454)

Get all the Sections in this Section. The Sections added to a Section are returned first in, first out (FIFO). Sections can be ordered explicitly using the orderSections method. Only the Sections directly associated with this Section are returned.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object SectionIterator getSections ()

getSectionType (line 191)

Get the SectionType for this Section. is meaningful to an application and not specifcally defined in the OSID

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getSectionType ()

orderItems (line 373)

Change the order of the Items in the Section. Items normally are

returned first in, first out (FIFO). This ordering, which has important pedagogical implications, is changed to match the order in the Items array. Additional added Items are returned first in, first out (FIFO) after the ordered Items.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ITEM

void orderItems (mixed $items, object Item[] $items )

object Item[] $items

orderSections (line 485)

Change the order of the Sections in the Section. Sections normally are

returned first in, first out (FIFO). This ordering, which has important pedagogical implications, is changed to match the order in the Sections array. Additional added Sections are returned first in, first out (FIFO) after the ordered Sections.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_SECTION

void orderSections (mixed $sections, object Section[] $sections )

object Section[] $sections

removeItem (line 316)

Remove an Item from this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void removeItem (mixed $itemId, object Id $itemId )

object Id $itemId

removeSection (line 428)

Remove a Section from this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void removeSection (mixed $sectionId, object Id $sectionId )

object Id $sectionId

updateData (line 98)

Update the data for this Section. The structure of the Data is not defined in the OSID. .

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateData (object mixed $data)

object mixed $data: (original type: java.io.Serializable)

updateDescription (line 72)

Update the description for this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 47)

Update the display name for this Section.

access: public
throws: object AssessmentException An exception with one of the following messages defined in org.osid.assessment.AssessmentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Documentation generated on Wed, 19 Sep 2007 10:26:20 -0400 by phpDocumentor 1.3.0RC3