clsNote

BOF business object for note data.

Purpose

• Represent persisted provider-domain data within the BOF object model.

Context

• Namespace: SAIF.Business.Provider
• Assembly/package: SAIF.Business.Provider

Public members

Member	Signature	Purpose
CbpNoteSeqNum	ReadOnly Property CbpNoteSeqNum As Decimal	Stores the CBP note sequence number value.
CreateDate	ReadOnly Property CreateDate As Date	Stores the create date value.
CreateUser	ReadOnly Property CreateUser As String	Exposes the create user value on this type.
UpdateDate	ReadOnly Property UpdateDate As Date	Returns the update date value recorded on the object.
UpdateNum	ReadOnly Property UpdateNum As Decimal	Returns the update num value recorded on the object.
UpdateUser	ReadOnly Property UpdateUser As String	Returns the update user value recorded on the object.
NoteTypeCode	Property NoteTypeCode As String	Stores the note type code value.
NoteCategoryCode	Property NoteCategoryCode As String	Stores the note category code value.
ActiveFlag	Property ActiveFlag As String	Stores the active flag.
BillID	Property BillID As Decimal	Stores the bill ID value.
ClaimID	Property ClaimID As Decimal	Stores the claim ID value.
ProviderSeqNum	Property ProviderSeqNum As Decimal	Stores the provider sequence number value.
ProviderLocationSeqNum	Property ProviderLocationSeqNum As Decimal	Stores the provider location sequence number value.
NoteTxt	Property NoteTxt As String	Exposes the note txt value on this type.
IsContactNote	Property IsContactNote As Boolean	Indicates whether contact note.
SetBillIDNull	Sub SetBillIDNull	Exposes set bill ID null behavior on this type.
SetClaimIDNull	Sub SetClaimIDNull	Exposes set claim ID null behavior on this type.
SetProviderSeqNumNull	Sub SetProviderSeqNumNull	Exposes set provider sequence number null behavior on this type.
SetProviderLocationSeqNumNull	Sub SetProviderLocationSeqNumNull	Exposes set provider location sequence number null behavior on this type.
SetNoteTxtNull	Sub SetNoteTxtNull	Exposes set note txt null behavior on this type.
IsBillIDNull	Function IsBillIDNull As Boolean	Exposes is bill ID null behavior on this type.
IsClaimIDNull	Function IsClaimIDNull As Boolean	Exposes is claim ID null behavior on this type.
IsProviderSeqNumNull	Function IsProviderSeqNumNull As Boolean	Exposes is provider sequence number null behavior on this type.
IsProviderLocationSeqNumNull	Function IsProviderLocationSeqNumNull As Boolean	Exposes is provider location sequence number null behavior on this type.
IsNoteTxtNull	Function IsNoteTxtNull As Boolean	Exposes is note txt null behavior on this type.
Equals	Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean	Exposes equals behavior on this type.
Equals	Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean	Exposes equals behavior on this type.
Equals	Overloads Function Equals(ByVal inObject As clsNote) As Boolean	Exposes equals behavior on this type.
GetHashCode	Overrides Function GetHashCode As Integer	Retrieves hash code through the BOF data portal.
NewCbpNote	Shared Function NewCbpNote(ByVal inDataportal As IDataPortalInfo, ByVal inProviderLocSeqNum As Decimal) As clsNote	Creates a new cbp note instance through the BOF data portal.
GetCbpNote	Shared Function GetCbpNote(ByVal inDataportal As IDataPortalInfo, ByVal inCbpNoteSeqNum As Decimal) As clsNote	Retrieves cbp note through the BOF data portal.

Behavioral notes

• This type participates in the provider-domain BOF object model and data-portal lifecycle.

Constraints and usage notes

• Use the BOF factory, retrieval, and save patterns associated with this library when changing persisted state.

Inherited members (from clsBusinessBase)

This type inherits the following public surface from clsBusinessBase (Legacy\BusinessObjectFramework\clsBusinessBase.vb), in addition to the members listed above:

Member	Signature	Purpose
MyGuid	ReadOnly Property MyGuid() As String	Returns the internal GUID that uniquely identifies this in-memory object instance.
IsNew	ReadOnly Property IsNew() As Boolean	Indicates whether the object has not yet been persisted.
IsDeleted	ReadOnly Property IsDeleted() As Boolean	Indicates whether the object is marked for deletion.
IsDirty	Overridable ReadOnly Property IsDirty() As Boolean	Indicates whether the object (or a child) has unsaved changes.
IsValid	Overridable ReadOnly Property IsValid() As Boolean	Indicates whether the object currently has no broken validation rules.
ValidateOnDelete	Property ValidateOnDelete As Boolean	Controls whether validation rules run before a delete operation.
Rules	ReadOnly Property Rules() As clsRulesManager	Returns the rules manager that tracks broken rules for this object.
ErrorCount	ReadOnly Property ErrorCount() As Integer	Returns the number of broken error-severity rules.
ErrorMessages	ReadOnly Property ErrorMessages() As String()	Returns the text of all broken error-severity rules.
WarningCount	ReadOnly Property WarningCount() As Integer	Returns the number of broken warning-severity rules.
WarningMessages	ReadOnly Property WarningMessages() As String()	Returns the text of all broken warning-severity rules.
InformationalCount	ReadOnly Property InformationalCount() As Integer	Returns the number of broken informational-severity rules.
InformationalMessages	ReadOnly Property InformationalMessages() As String()	Returns the text of all broken informational-severity rules.
BeginEdit	Sub BeginEdit()	Begins an editable transaction, snapshotting current field values.
CancelEdit	Sub CancelEdit()	Rolls back field values to the last BeginEdit snapshot.
ApplyEdit	Sub ApplyEdit()	Commits the current edit transaction, discarding the rollback snapshot.
Delete	Sub Delete()	Marks the object for deletion on the next save.
Save	Overridable Function Save() As Boolean	Persists the object (insert, update, or delete) through the BOF data portal, if valid.
SaveChild	Overridable Function SaveChild() As Boolean	Persists the object as a child of a parent object/collection.
Clone	Function Clone() As Object	Returns a deep copy of the object.
XMLElementName	Property XMLElementName() As String	Gets or sets the XML element name used when serializing this object.
GetDataset	Sub GetDataset(ByRef inDS As DataSet)	Populates a DataSet with the object's field values.
GetDataset (named table)	Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)	Populates a DataSet table with the given name with the object's field values.
GetReportXML	Function GetReportXML(ByVal inElementName As String) As String	Returns an XML fragment representing the object using the supplied element name.
GetReportXML (default name)	Function GetReportXML() As String	Returns an XML fragment representing the object using the default XML element name.
ToXml	Function ToXml() As String	Serializes the object to XML using the default element name.
ToXml (named tag)	Function ToXml(ByVal inTagName As String) As String	Serializes the object to XML using the supplied tag name.
PreviousLinkItem / NextLinkItem	ReadOnly Property PreviousLinkItem() As ILinkItem / ReadOnly Property NextLinkItem() As ILinkItem	Returns the adjacent linked-list item for collection traversal.
SetValueOnChange	Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean	Sets a backing field only when the value changes, optionally marking the object dirty.
## Sources
- Business\SAIF.Business.Provider\clsNote.vb