GetTimePunchStateModel Class

This class is the model for retrieving a user’s available punch type statues

Inheritance Hierarchy

SystemObject
AppOne.Services.V2.ContractsGetTimePunchStateModel

Namespace: AppOne.Services.V2.Contracts
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141

Syntax

JavaScript

Copy

public class GetTimePunchStateModel

AppOne.Services.V2.Contracts.GetTimePunchStateModel = function();

Type.createClass(
	'AppOne.Services.V2.Contracts.GetTimePunchStateModel');

The GetTimePunchStateModel type exposes the following members.

Properties

	Name	Description
	EmpIdentifier	The employee identifier that is bound to the GetTimePunchStateModel result set.
	PunchMessage	A message indicating the next possible blocked status or restriction that may be in place for a user based on their profile configuration.
	PunchStatus	The status to indicate if a punch is valid or blocked.
	PunchTypeId	Returns a comma separated list of punch type ids in the order of the next available punch type.
	PunchTypeName	Returns a comma separated list of punch type names in the order of the next available punch type.

Top

Remarks

This class is the model for retrieving a user’s available punch type statues.

Note
Business Rules: Punching in and out is the core of the time-web system. The WSTime class encapsulate the needed methods/operations to interact with a users time entry. Users can be assigned to different preferences and policies. These policies are what will affect the results of a users time entry into the system. Setup: Employee > Dashboard Manager > Time Cards

Caution
The punch statuses for a manager can differ in the different user interfaces. For example a manager view may have an "End Break" as an option, where the employee doesn't see this in their interfaces. An employee may not have the option to use breaks, then this will affect the results for the Model returned. The Model is tightly coupled with how an "Employee's View" is shown. For a better correlation of the results returned in this Model see the "Employee's Dashboard". Payroll Policies effect the punch types that an employee can view. Be sure to review the payroll policy assigned to the user. For example if a user was assigned to a payroll policy that didn't allow breaks or meals then logging in as the employee would not allow them to punch against the "Begin Break"/"End Break" or "Begin Meal"/"End Meal" options, however these options still may be visible to a manager.

Caution

The punch statuses for a manager can differ in the different user interfaces. For example a manager view may have an "End Break" as an option, where the employee doesn't see this in their interfaces. An employee may not have the option to use breaks, then this will affect the results for the Model returned. The Model is tightly coupled with how an "Employee's View" is shown. For a better correlation of the results returned in this Model see the "Employee's Dashboard".

Payroll Policies effect the punch types that an employee can view. Be sure to review the payroll policy assigned to the user. For example if a user was assigned to a payroll policy that didn't allow breaks or meals then logging in as the employee would not allow them to punch against the "Begin Break"/"End Break" or "Begin Meal"/"End Meal" options, however these options still may be visible to a manager.

Example

For example code see GetTimePunchState(GetTimePunchStateIn)

Reference

AppOne.Services.V2.Contracts Namespace