[This is preliminary documentation and is subject to change.]
An ObjectMapping defines a set of field mapping rules for a specific SIF Data
Object type such as StudentPersonal, StaffPersonal, or BusInfo. ObjectMapping
is comprised of zero or more FieldMapping children.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class ObjectMapping
Public Class ObjectMapping
public ref class ObjectMapping
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | ObjectMappingObjectMappingNew(String) | Constructor |
| ObjectMappingObjectMappingNew(String, XmlElement) | Constructor |
| AddRule(FieldMapping) | Appends a FieldMapping definition
|
| ClearRules()() | Clear all FieldMapping definitions. |
| Copy(Mappings) | Creates a copy this ObjectMapping instance.
This method performs a "deep copy", such that a clone is made of each
child FieldMapping. The parent of the new ObjectMapping will be the
Mappings object passed to this function. Any DOM Nodes assigned to this
object or its children are cloned and appended to the parent Mappings's
DOM XmlElement if one exists.
|
| GetRule(Int32) | Gets the FieldMapping at the specified index |
| GetRules(Boolean) | Return an array of all FieldMapping definitions |
| InsertRule(FieldMapping, Int32) | Insert a FieldMapping definition at the specified index.
|
 | ObjectType | Gets the SIF Data Object type of this ObjectMapping |
| RemoveRule(FieldMapping) | Remove a FieldMapping definition |
| RemoveRule(Int32) | Removes the FieldMapping at the specified index |
| RuleCount | Count the number of FieldMapping definitions. |
| XmlElement | Gets the optional DOM XmlElement associated with this ObjectMapping instance.
The DOM XmlElement is usually set by the parent Mappings object when an
ObjectMapping is populated from a DOM Document.
Sets the optional DOM XmlElement associated with this ObjectMapping instance.
The DOM XmlElement is usually set by the parent Mappings object when an
ObjectMapping is populated from a DOM Document.
|
Inheritance Hierarchy| Object | |
 | ObjectMapping |