Alias Property

[This is preliminary documentation and is subject to change.]

Gets or sets an alias of another field mapping.

Declaration Syntax

Visual Basic

Visual C++

public virtual string Alias{ get; set;}

Public Overridable Property Alias As String

public:
virtual property String^ Alias {
	String^ get ();
	void set (String^ value);
}

Value

The name of the field for which this entry is an alias, or null if this FieldMapping is not an alias.

Remarks

Defines this FieldMapping to be an alias of another field mapping. During the mapping process, the FieldMapping will be applied if the referenced field exists in the Map provided to the Mappings.map method. Aliases are required when an application wishes to map a single application field to more than one element or attribute in the SIF Data Object. To use aliases, create a FieldMapping where the field name is a unique name and the alias is the name of an existing field. For example, to map an application-defined field named "STUDENT_NUM" to more than one element/attribute in the SIF Data Object,

Examples

CopyC#

// Create the default mapping<br />
FieldMapping fm = new FieldMapping("STUDENT_NUM","OtherId[@Type='06']");
// Create an alias; the field name must be unique<br />
FieldMapping fm2 = new FieldMapping("STUDENT_NUM_B","OtherId[@Type='ZZ']=STUDENTID:$(STUDENTNUM)");<br />

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10