Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Office Hours. More...

Inheritance diagram for MixERP.Net.Api.HRM.OfficeHourController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "office hour" entity. More...

long	Count ()
	Counts the number of office hours. More...

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	Get ()
	Returns collection of office hour for export. More...

MixERP.Net.Entities.HRM.OfficeHour	Get (int officeHourId)
	Returns an instance of office hour. More...

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	Get ([FromUri] int[] officeHourIds)

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	GetPagedResult ()
	Creates a paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId. More...

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of office hours using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId. More...

long	CountFiltered (string filterName)
	Counts the number of office hours using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.HRM.OfficeHour >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of office hours. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for office hours. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for office hours. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of OfficeHour class. More...

void	Add (MixERP.Net.Entities.HRM.OfficeHour officeHour)
	Adds your instance of OfficeHour class. More...

void	Edit (int officeHourId, [FromBody] MixERP.Net.Entities.HRM.OfficeHour officeHour)
	Edits existing record with your instance of OfficeHour class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of OfficeHour class. More...

void	Delete (int officeHourId)
	Deletes an existing instance of OfficeHour class via OfficeHourId. More...

Properties
long	LoginId `[get]`

int	UserId `[get]`

int	OfficeId `[get]`

string	Catalog `[get]`

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Office Hours.

Member Function Documentation

void MixERP.Net.Api.HRM.OfficeHourController.Add ( MixERP.Net.Entities.HRM.OfficeHour officeHour )

Adds your instance of OfficeHour class.

Parameters

officeHour Your instance of office hours class to add.

void MixERP.Net.Api.HRM.OfficeHourController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of OfficeHour class.

Parameters

officeHour Your instance of office hours class to add or edit.

List<object> MixERP.Net.Api.HRM.OfficeHourController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of OfficeHour class.

Parameters

collection Your collection of OfficeHour class to bulk import.

Returns: Returns list of imported officeHourIds.

Exceptions

MixERPException Thrown when your any OfficeHour class in the collection is invalid or malformed.

long MixERP.Net.Api.HRM.OfficeHourController.Count ( )

Counts the number of office hours.

Returns: Returns the count of the office hours.

long MixERP.Net.Api.HRM.OfficeHourController.CountFiltered ( string filterName )

Counts the number of office hours using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered office hours.

long MixERP.Net.Api.HRM.OfficeHourController.CountWhere ( [FromBody] dynamic filters )

Counts the number of office hours using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered office hours.

void MixERP.Net.Api.HRM.OfficeHourController.Delete ( int officeHourId )

Deletes an existing instance of OfficeHour class via OfficeHourId.

Parameters

officeHourId Enter the value for OfficeHourId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.OfficeHourController.Edit	(	int	officeHourId,
		[FromBody] MixERP.Net.Entities.HRM.OfficeHour	officeHour
	)

Edits existing record with your instance of OfficeHour class.

Parameters

officeHour	Your instance of OfficeHour class to edit.
officeHourId	Enter the value for OfficeHourId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.OfficeHour> MixERP.Net.Api.HRM.OfficeHourController.Get ( )

Returns collection of office hour for export.

Returns

MixERP.Net.Entities.HRM.OfficeHour MixERP.Net.Api.HRM.OfficeHourController.Get ( int officeHourId )

Returns an instance of office hour.

Parameters

officeHourId Enter OfficeHourId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.OfficeHourController.GetCustomFields ( )

A custom field is a user defined field for office hours.

Returns: Returns an enumerable custom field collection of office hours.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.OfficeHourController.GetCustomFields ( string resourceId )

A custom field is a user defined field for office hours.

Returns: Returns an enumerable custom field collection of office hours.

IEnumerable<DisplayField> MixERP.Net.Api.HRM.OfficeHourController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of office hours.

Returns: Returns an enumerable key/value collection of office hours.

EntityView MixERP.Net.Api.HRM.OfficeHourController.GetEntityView ( )

Creates meta information of "office hour" entity.

Returns: Returns the "office hour" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.HRM.OfficeHour> MixERP.Net.Api.HRM.OfficeHourController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId.

Parameters

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

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.HRM.OfficeHour> MixERP.Net.Api.HRM.OfficeHourController.GetPagedResult ( )

Creates a paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.OfficeHour> MixERP.Net.Api.HRM.OfficeHourController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.OfficeHour> MixERP.Net.Api.HRM.OfficeHourController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 office hours on each page, sorted by the property OfficeHourId.

Parameters

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

Returns: Returns the requested page from the collection using the supplied filters.

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

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/FrontEnd/MixERP.Net.FrontEnd/Modules/HRM.API/OfficeHourController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation