[This is preliminary documentation and is subject to change.]
An example SIF object that serves as a template for matching objects. There is an implied EQ operator
for every element/attribute value present and an implied And group of all resulting conditions. Currently
this is an experimental feature and limited to use with StudentLocator; wider use may be considered in future
major versions of this specification.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class StudentLocator : SifDataObject
Public Class StudentLocator _ Inherits SifDataObject
public ref class StudentLocator : public SifDataObject
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | StudentLocatorStudentLocatorNew()() |
Creates an instance of a StudentLocator
|
| StudentLocatorStudentLocatorNew(IdStatus, StatePrCode, String) |
Constructor that accepts values for all mandatory fields
|
| AddAddress(Address) | Adds a new <Address> child element. |
| AddAddress(AddressType, Street, String, StatePrCode, CountryCode, String) | Adds the value of the <Address> element. |
| AddContact(SLContact) | Adds a new <Contact> child element. |
| AddContact(Relationship) | Adds the value of the <Contact> element. |
| AddName(Name) | Adds a new <Name> child element. |
| AddName(NameType, String, String) | Adds the value of the <Name> element. |
| AddRequestingAgencyId(RequestingAgencyId) | Adds a new <RequestingAgencyId> child element. |
| AddRequestingAgencyId(RequestingAgencyIdType, String) | Adds the value of the <RequestingAgencyId> element. |
 | Confidence |
Gets or sets the value of the <Confidence> element.
|
| Demographics |
Gets or sets the value of the <Demographics> element.
|
| EffectiveDate |
Gets or sets the value of the <EffectiveDate> element.
|
| EndDate |
Gets or sets the value of the <EndDate> element.
|
| GetAddress(AddressType) |
Gets an Address object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| GetAddresses()() |
Gets all Address object instances. More than once instance can be defined for this object because it is a repeatable field element.
|
| GetContact(Relationship) |
Gets a SLContact object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| GetContacts()() |
Gets all SLContact object instances. More than once instance can be defined for this object because it is a repeatable field element.
|
| GetName(NameType) |
Gets a Name object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| GetNames()() |
Gets all Name object instances. More than once instance can be defined for this object because it is a repeatable field element.
|
| GetRequestingAgencyId(RequestingAgencyIdType) |
Gets a RequestingAgencyId object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| GetRequestingAgencyIds()() |
Gets all RequestingAgencyId object instances. More than once instance can be defined for this object because it is a repeatable field element.
|
| GradeLevel |
Gets or sets the value of the <GradeLevel> element.
|
| GraduationDate |
Gets or sets the value of the <GraduationDate> element.
|
| IdStatus |
Gets or sets the value of the IdStatus attribute.
|
| LocalId |
Gets or sets the value of the <LocalId> element.
|
| OtherId |
Gets or sets the value of the <OtherId> element.
|
| RemoveAddress(AddressType) |
Removes an Address object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| RemoveContact(Relationship) |
Removes a SLContact object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| RemoveName(NameType) |
Removes a Name object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| RemoveRequestingAgencyId(RequestingAgencyIdType) |
Removes a RequestingAgencyId object instance. More than one instance can be defined for this object because it is a repeatable field element.
|
| SchoolAttendedLocation |
Gets or sets the value of the <SchoolAttendedLocation> element.
|
| SchoolAttendedName |
Gets or sets the value of the <SchoolAttendedName> element.
|
| SetAddresses(array<Address>[]()) |
Sets all Address object instances. All existing
Address instances
are removed and replaced with this list. Calling this method with the
parameter value set to null removes all Addresses.
|
| SetContacts(array<SLContact>[]()) |
Sets all SLContact object instances. All existing
SLContact instances
are removed and replaced with this list. Calling this method with the
parameter value set to null removes all SLContacts.
|
| SetGradeLevel(GradeLevelCode) | Sets the value of the <GradeLevel> element. |
| SetGraduationDate(String) | Sets the value of the <GraduationDate> element. |
| SetIdStatus(IdStatus) |
Sets the value of the IdStatus attribute.
|
| SetNames(array<Name>[]()) |
Sets all Name object instances. All existing
Name instances
are removed and replaced with this list. Calling this method with the
parameter value set to null removes all Names.
|
| SetOtherId(OtherIdType, String) | Sets the value of the <OtherId> element. |
| SetRequestingAgencyIds(array<RequestingAgencyId>[]()) |
Sets all RequestingAgencyId object instances. All existing
RequestingAgencyId instances
are removed and replaced with this list. Calling this method with the
parameter value set to null removes all RequestingAgencyIds.
|
| SetSIF_Error(Nullable<(Of <Int32>)>, Nullable<(Of <Int32>)>, String) | Sets the value of the <SIF_Error> element. |
| SetStateProvinceId(StatePrCode) |
Sets the value of the <StateProvinceId> element.
|
| SIF_Error |
Gets or sets the value of the <SIF_Error> element.
|
| SSN |
Gets or sets the value of the <SSN> element.
|
| StartDate |
Gets or sets the value of the <StartDate> element.
|
| StateProvinceId |
Gets or sets the value of the <StateProvinceId> element.
|
| StudentPersonalRefId |
Gets or sets the value of the <StudentPersonalRefId> element.
|
| TransactionId |
Gets or sets the value of the TransactionId attribute.
|
RemarksAuthor: Generated by adkgen
Version: 2.0
Since: 1.5r1
Inheritance Hierarchy| Object | |||||
 | Element | ||||
| SifElement | ||||
| SifKeyedElement | ||||
| SifDataObject | ||||
| StudentLocator | ||||