Symphony Framework
DataObjectBase Class Members
Fields  Properties  Methods  Events


Symphony.Conductor.Model Namespace : DataObjectBase Class

The following tables list the members exposed by DataObjectBase.

Protected Fields
 NameDescription
Protected Field Store the current field number.  
Protected Field Backing field to hold all field level information.  
Protected Field This logic allows a generated data oject to store off a copy of the field details and prevent itself from re-creating them.  
Protected Field Backing field to stre the objects field headings for report/excel export, etc.  
Protected Field Backing field to store the objects field names.  
Protected Field Storage of the IsDataModified flag.  
Protected Field Storage of the IsNew flag.  
Protected Field Internal/protected string expresion of the data object value.  
Protected FieldProtected field that can be used by the extending class to force validation of data when setting objectvalues using the Synergy Record property  
Top
Public Properties
 NameDescription
Public PropertyAllow read-only access to all the error information as a property. The AllErrors proeprty returns a Generic List of DataObjectErrorInfo types.  
Public Property Error value.  
Public PropertyReadonly property that returns the report headings of the fields defined within the Symphony Data Object.  
Public PropertyReadonly property that returns the names of the fields defined within the Symphony Data Object.  
Public PropertyExpose a simpler property that allows you to store/retreive the Symphony Data Object global RFA address.  
Public PropertyString variable that allows the creating host object to label the Symphony Data Object.  
Public Property property to determine of the data has changed  
Public Property property to determine if the object is valid  
Public Property property to determine of the data is new  
Public Property Error indexer that accepts the field name to signal that fields error  
Public PropertyBy un-setting the ObjectRaisesPropertyChanged property the Symphony Data Object will not raise the PropertyChanged event to notify the UI that the field data has changed. By default this property value is True. You should set this property if you are using the object for internal use and it is not data-bound to the UI.  
Public Property This proprety is used by your programs to record the "original" state of a record. By setting this property the IsDataModified property will be set to False. If you wish to change this behaviour then explicity set IsDataModified = true in your code.  
Public Property Expose the underlying structure size.  
Public Property property to be replaced by the extending class to expose the synergy record data  
Top
Public Methods
 NameDescription
Public MethodAllow the comsumer class of a Symphony Data Object to add/alter the change validation method associated with a property.  
Public Method Virtal method to be overriden by the implementing class.  
Public Method Virtal method to be overriden by the implementing class.  
Public MethodReturn a Generic List of DataObjectErrorInfo types of error information stored for the current Symphony Data Object.  
Public MethodMethod to ensure that Synergy Record data is validated  
Public Method Return the IsEnabled state of the field defined by the passed index  
Public Method Return the field index based on the passed field name.  
Public Method Return the Notify state of the field defined by the passed index.  
Public Method Return the IsReadOnly state of the field defined by the passed index  
Public Method Method to allow the extending class to initialise class fields, etc.  
Public Method Method to allow the extending class to initialise class fields, etc.  
Public Method Method to be replaced by the extending class to initialise all member data fields  
Public Method Riase the required events to signal a proerty is requeting focus  
Public Method  
Public MethodThis method allows you to restore the internal data area (SynergyRecord) of a Symphony Data Object to it's original value. The original value must have previously been stored in the OriginalSynergyRecord property. This OriginalSynergyRecord value is then used to reset the SynergyRecord value. All the required RaisePropertyChanged events are fired and the IsModified property will be reset to False.  
Public Method allows the code generated class to set the IsEnabled state  
Public MethodAllow the comsumer class of a Symphony Data Object to enable or disable fields  
Public Method method to be replaced by the extending class that will set the required field focus flag  
Public Method allows the code generated class to set the Notify state.  
Public Method allows the code generated class to set the IsReadOnly state  
Public MethodAllow the comsumer class of a Symphony Data Object to change the RadOnly status of fields.  
Public MethodAllow the comsumer class of a Symphony Data Object to enable or disable field level validation  
Public Method allow code to set the data invalid  
Public Method method to allow the raising of the data validation routine.  
Top
Protected Methods
 NameDescription
Protected MethodA place holder routine that allows for additional Synergy Record processing. This method, if implemented in the extending class, will be executed when the Synergy Record property Set method is accessed. It allows for additional processing of non-repository structure fields.  
Protected Method A place holder routine that allows for additional constructor processing. This method, if implemented in the extending class, will be executed during standard constructor execution. The method allows for additional processing such as initializing non-repository structure fields.  
Protected Method Method to allow the extending class to raise the PropertyChanged event for non-repository based fields/properties  
Protected Method Method to allow the extending class to raise the PropertyChanged event  
Protected Method Method to allow the extending class to raise the SynergyRecordChanged event.  
Protected Method Method to allow the setting of field level errors  
Protected Method  
Protected Method Allow the setting of a field as "valid" by the class.  
Protected MethodMethod to allow the extending class to indicate the Symphony Data Object has changed. The IsNew flag is set to False.  
Protected Methodstatic (Shared in Visual Basic)This method is required for each field defined within the extended Symphony Data Object class. Is configures each individual field within the Symphony Data Object and assigns validation information  
Top
Public Events
 NameDescription
Public EventThe ExecuteChange event is raised when a Symphony Data Object change method execution is required.  
Public EventThe FieldHasFocus event is raised when a property on the Symphony Data Object is requesting focus.  
Public Event Event raised when a property/field has lost focus.  
Public EventDefine the event to raise when the data in the Symphony Data Object is modified.  
Public EventDefine the event to raise when the validity of the data within the Symphony Data Object has changed.  
Public Event Define the event to raise when the IsNEw property has changed.  
Public Event Allow change notifications  
Public EventDefine the event to raise when the validity of the data within the Symphony Data Object has changed.  
Public EventThe ValidateData event is raised when a Symphony Data Object property value has been changed and validation of the modified data is required.  
Top
See Also

Reference

DataObjectBase Class
Symphony.Conductor.Model Namespace