MixERP.Net.Schemas.Office.Data.Office Class Reference

Provides simplified data access features to perform SCRUD operation on the database table "office.offices". More...

Inheritance diagram for MixERP.Net.Schemas.Office.Data.Office:

Public Member Functions
long	Count ()
	Performs SQL count on the table "office.offices". More...
IEnumerable< MixERP.Net.Entities.Office.Office >	Get ()
	Executes a select query on the table "office.offices" to return a all instances of the "Office" class to export. More...
MixERP.Net.Entities.Office.Office	Get (int officeId)
	Executes a select query on the table "office.offices" with a where filter on the column "office_id" to return a single instance of the "Office" class. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	Get (int[] officeIds)
	Executes a select query on the table "office.offices" with a where filter on the column "office_id" to return a multiple instances of the "Office" class. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	Custom fields are user defined form elements for office.offices. More...
IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfields provide a minimal name/value context for data binding the row collection of office.offices. More...
void	AddOrEdit (MixERP.Net.Entities.Office.Office office, List< EntityParser.CustomField > customFields)
	Inserts or updates the instance of Office class on the database table "office.offices". More...
object	Add (MixERP.Net.Entities.Office.Office office)
	Inserts the instance of Office class on the database table "office.offices". More...
List< object >	BulkImport (List< MixERP.Net.Entities.Office.Office > offices)
	Inserts or updates multiple instances of Office class on the database table "office.offices"; More...
void	Update (MixERP.Net.Entities.Office.Office office, int officeId)
	Updates the row of the table "office.offices" with an instance of "Office" class against the primary key value. More...
void	Delete (int officeId)
	Deletes the row of the table "office.offices" against the primary key value. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetPagedResult ()
	Performs a select statement on table "office.offices" producing a paged result of 25. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetPagedResult (long pageNumber)
	Performs a select statement on table "office.offices" producing a paged result of 25. More...
long	CountWhere (List< EntityParser.Filter > filters)
	Performs a filtered count on table "office.offices". More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetWhere (long pageNumber, List< EntityParser.Filter > filters)
	Performs a filtered select statement on table "office.offices" producing a paged result of 25. More...
long	CountFiltered (string filterName)
	Performs a filtered count on table "office.offices". More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetFiltered (long pageNumber, string filterName)
	Performs a filtered select statement on table "office.offices" producing a paged result of 25. More...
Public Member Functions inherited from PetaPoco.DbAccess
void	Validate (AccessTypeEnum type, long loginId, bool noException)
	Validates application user access rights to execute the function. More...

Public Attributes
override string	ObjectNamespace => "office"
	The schema of this table. Returns literal "office". More...
override string	ObjectName => "offices"
	The schema unqualified name of this table. Returns literal "offices". More...

Properties
long	LoginId [get, set]
	Login id of application user accessing this table. More...
int	UserId [get, set]
	User id of application user accessing this table. More...
string	Catalog [get, set]
	The name of the database on which queries are being executed to. More...
Properties inherited from PetaPoco.DbAccess
abstract string	ObjectNamespace [get]
abstract string	ObjectName [get]
bool	HasAccess [get]
bool	Validated [get]
bool	SkipValidation [get, set]
Properties inherited from PetaPoco.IDBAccess
bool	HasAccess [get]

Detailed Description

Provides simplified data access features to perform SCRUD operation on the database table "office.offices".

Member Function Documentation

object MixERP.Net.Schemas.Office.Data.Office.Add

(

MixERP.Net.Entities.Office.Office

office

)

Inserts the instance of Office class on the database table "office.offices".

Parameters

office

The instance of "Office" class to insert.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

void MixERP.Net.Schemas.Office.Data.Office.AddOrEdit	(	MixERP.Net.Entities.Office.Office	office,
		List< EntityParser.CustomField >	customFields
	)

Inserts or updates the instance of Office class on the database table "office.offices".

Parameters

office	The instance of "Office" class to insert or update.
customFields	The custom field collection.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

List<object> MixERP.Net.Schemas.Office.Data.Office.BulkImport

(

List< MixERP.Net.Entities.Office.Office >

offices

)

Inserts or updates multiple instances of Office class on the database table "office.offices";

Parameters

offices

List of "Office" class to import.

Returns

long MixERP.Net.Schemas.Office.Data.Office.Count

(

)

Performs SQL count on the table "office.offices".

Returns

Returns the number of rows of the table "office.offices".

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

long MixERP.Net.Schemas.Office.Data.Office.CountFiltered

(

string

filterName

)

Performs a filtered count on table "office.offices".

Parameters

filterName

The named filter.

Returns

Returns number of rows of "Office" class using the filter.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

long MixERP.Net.Schemas.Office.Data.Office.CountWhere

(

List< EntityParser.Filter >

filters

)

Performs a filtered count on table "office.offices".

Parameters

filters

The list of filter conditions.

Returns

Returns number of rows of "Office" class using the filter.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

void MixERP.Net.Schemas.Office.Data.Office.Delete

(

int

officeId

)

Deletes the row of the table "office.offices" against the primary key value.

Parameters

officeId

The value of the column "office_id" which will be deleted.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.Get

(

)

Executes a select query on the table "office.offices" to return a all instances of the "Office" class to export.

Returns

Returns a non-live, non-mapped instances of "Office" class.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

MixERP.Net.Entities.Office.Office MixERP.Net.Schemas.Office.Data.Office.Get

(

int

officeId

)

Executes a select query on the table "office.offices" with a where filter on the column "office_id" to return a single instance of the "Office" class.

Parameters

officeId

The column "office_id" parameter used on where filter.

Returns

Returns a non-live, non-mapped instance of "Office" class mapped to the database row.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.Get

(

int[]

officeIds

)

Executes a select query on the table "office.offices" with a where filter on the column "office_id" to return a multiple instances of the "Office" class.

Parameters

officeIds

Array of column "office_id" parameter used on where filter.

Returns

Returns a non-live, non-mapped collection of "Office" class mapped to the database row.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Schemas.Office.Data.Office.GetCustomFields

(

string

resourceId

)

Custom fields are user defined form elements for office.offices.

Returns

Returns an enumerable custom field collection for the table office.offices

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<DisplayField> MixERP.Net.Schemas.Office.Data.Office.GetDisplayFields

(

)

Displayfields provide a minimal name/value context for data binding the row collection of office.offices.

Returns

Returns an enumerable name and value collection for the table office.offices

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Performs a filtered select statement on table "office.offices" producing a paged result of 25.

Parameters

pageNumber	Enter the page number to produce the paged result.
filterName	The named filter.

Returns

Returns collection of "Office" class.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.GetPagedResult

(

)

Performs a select statement on table "office.offices" producing a paged result of 25.

Returns

Returns the first page of collection of "Office" class.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.GetPagedResult

(

long

pageNumber

)

Performs a select statement on table "office.offices" producing a paged result of 25.

Parameters

pageNumber

Enter the page number to produce the paged result.

Returns

Returns collection of "Office" class.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Schemas.Office.Data.Office.GetWhere	(	long	pageNumber,
		List< EntityParser.Filter >	filters
	)

Performs a filtered select statement on table "office.offices" producing a paged result of 25.

Parameters

pageNumber	Enter the page number to produce the paged result.
filters	The list of filter conditions.

Returns

Returns collection of "Office" class.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

void MixERP.Net.Schemas.Office.Data.Office.Update	(	MixERP.Net.Entities.Office.Office	office,
		int	officeId
	)

Updates the row of the table "office.offices" with an instance of "Office" class against the primary key value.

Parameters

office	The instance of "Office" class to update.
officeId	The value of the column "office_id" which will be updated.

Exceptions

UnauthorizedException

Thown when the application user does not have sufficient privilege to perform this action.

Member Data Documentation

override string MixERP.Net.Schemas.Office.Data.Office.ObjectName => "offices"

The schema unqualified name of this table. Returns literal "offices".

override string MixERP.Net.Schemas.Office.Data.Office.ObjectNamespace => "office"

The schema of this table. Returns literal "office".

Property Documentation

string MixERP.Net.Schemas.Office.Data.Office.Catalog

getset

The name of the database on which queries are being executed to.

long MixERP.Net.Schemas.Office.Data.Office.LoginId

getset

Login id of application user accessing this table.

int MixERP.Net.Schemas.Office.Data.Office.UserId

getset

User id of application user accessing this table.

---

The documentation for this class was generated from the following file:

• C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/DAL/Office/Office.cs