Interface IBusinessObject

This interface defines the very basic interface supported by all business objects 

public abstract interface IBusinessObject

Interface Members

MemberDescription
AddNew Creates a new instance of the current master entity.
public DataSet AddNew();
Delete This method deletes a single row in the master entity based on its PK
public bool Delete( string entityPK );

public bool Delete( Guid entityPK );

public bool Delete( int entityPK );

GetList Retrieves a list of main entity data
public DataSet GetList();
GetNewIntegerKey This method creates a new key for integer-key rows.
public int GetNewIntegerKey( string entityName,
DataSet dataSetWithNewRecord );
GetNewStringKey This method creates a new key for string-key rows.
public string GetNewStringKey( string entityName,
DataSet dataSetWithNewRecords );
LoadEntity Loads a single record of the main entity into a dataset and returns it.
public DataSet LoadEntity( string entityPK );

public DataSet LoadEntity( Guid entityPK );

public DataSet LoadEntity( int entityPK );

LogBusinessRuleViolation This method can be used to log business rule violations.
public void LogBusinessRuleViolation( DataSet currentDataSet,
string tableName,
string fieldName,
int rowIndex,
RuleViolationType violationType,
string message,
string ruleClass );
Save Saves a dataset to the back end
public bool Save( DataSet masterDataSet );

public bool Save( IBusinessEntity entity );

public bool Save( IBusinessEntity[] entities );

public bool Save( DataSet[] masterDataSets );

Verify This method is used to verify whether the current dataset is valid.
public bool Verify( DataSet masterDataSet );
DeleteMethod Defines the method used to delete records on the database back end
MasterEntity Name of the master entity this business object is responsible for.
PrimaryKeyField Name of the primary key field used by the master entity in this business object
PrimaryKeyType Primary key type this object operates on
QueryMethod Defines the method used to query records on the database back end (for automated queries)
UpdateMethod Defines how the data base back end is to be updated (sql commands, stored procs,...)
UpdateMode Defines whether only changed fields (default) or the complete record will be written

Requirements

Namespace: EPS.Business.BusinessObjects
Assembly: BUSINESSOBJECTS.DLL

  Last Updated: 5/23/2007 | © , 2007