scheduler-node-models 1.0.81 → 1.0.83

package/scheduler/employees/employee.d.ts

@@ -0,0 +1,420 @@
+import { ObjectId } from "mongodb";
+import { EmployeeName, IEmployeeName } from "./employeename";
+import { ICompanyInfo } from "./companyinfo";
+import { Assignment, IAssignment } from "./assignment";
+import { IVariation, Variation } from "./variation";
+import { ILeaveRequest, LeaveRequest } from "./leaverequest";
+import { EmployeeLaborCode, IEmployeeLaborCode } from "./labor";
+import { IWork, Work } from "./work";
+import { IUser, User } from "../../users";
+import { Contact, IContact } from "./contact";
+import { ISpecialty, Specialty } from "./specialty";
+import { ILeave, Leave } from "./leave";
+import { Workday } from "./workday";
+import { AnnualLeave, IAnnualLeave } from "./balance";
+import { CompareWorkCode, Workcode } from '../labor/workcode';
+import { ChangeLeaveRequestResponse } from "./web";
+import { LaborCode } from "../labor/laborcode";
+/**
+ * The employee is recorded by
+ */
+export interface IEmployee {
+    _id?: ObjectId;
+    id?: string;
+    team: string;
+    site: string;
+    email: string;
+    name: IEmployeeName;
+    companyinfo: ICompanyInfo;
+    assignments?: IAssignment[];
+    variations?: IVariation[];
+    balance?: IAnnualLeave[];
+    leaves?: ILeave[];
+    requests?: ILeaveRequest[];
+    laborCodes?: IEmployeeLaborCode[];
+    work?: IWork[];
+    user?: IUser;
+    contactinfo?: IContact[];
+    specialties?: ISpecialty[];
+    emails?: string[];
+}
+export declare class Employee implements IEmployee {
+    id: string;
+    team: string;
+    site: string;
+    email: string;
+    name: EmployeeName;
+    companyinfo: ICompanyInfo;
+    assignments: Assignment[];
+    variations: Variation[];
+    balance: AnnualLeave[];
+    leaves: Leave[];
+    requests: LeaveRequest[];
+    laborCodes: EmployeeLaborCode[];
+    work?: Work[];
+    user?: User;
+    contactinfo: Contact[];
+    specialties: Specialty[];
+    emails: string[];
+    constructor(emp?: IEmployee);
+    compareTo(other?: Employee): number;
+    /**
+     * This function will clone this object, but remove all the work and user objects
+     * so they aren't saved in the database.  They are saved in other collections.
+     * @returns An employee object for saving to the database
+     */
+    cloneForSave(): Employee;
+    /**
+     * This function is designed to remove old data from this employee object.  It will
+     * remove old variations, leaves, leave requests, and leave balances, if they are
+     * older than the date given.
+     * @param date This date value is used for comparison, for anything before this date.
+     * @returns A boolean value to indicate to the calling function whether or not to
+     * remove this employee.
+     */
+    purge(date: Date): boolean;
+    /**********************************************************************************
+     * This is the assignments section for modifying the assignment list.
+     **********************************************************************************/
+    /**
+     * Remove Leaves between and including dates.
+     * @param start The date for the start of the removal
+     * @param end The date for the end of the removal
+     * @param reqID (Optional) the string value for a possible request identifier
+     * @param includeActuals (Optional) the boolean value to delete actuals
+     */
+    removeLeaves(start: Date, end: Date, reqID?: string, includeActuals?: boolean): void;
+    /**
+     * This function is used to determine if the employee is active on the date given.
+     * @param date The date object used to determine whether or not the employee was active
+     * on this date.
+     * @returns A boolean value for whether or not the employee was active.
+     */
+    isActive(date: Date): boolean;
+    /**
+     * This function is used to determine if the employee is active during a particular
+     * period of time at a site and workcenter.
+     * @param site The string value to designate the site.
+     * @param wkctr The string value to designate the workcenter.
+     * @param start The date object for the start of the requested period.
+     * @param end The date object for the end of the requested period.
+     * @returns The boolean value to indicate the employee was working at the site and
+     * workcenter during the period.
+     */
+    isAssigned(site: string, wkctr: string, start: Date, end: Date): boolean;
+    /**
+     * This function is used to determine if the employee is active at a site during a
+     * period of time.
+     * @param site The string value to designate the site.
+     * @param start The date object for the start of the requested period.
+     * @param end The date object for the end of the requested period.
+     * @returns The boolean value to indicate the employee was working at the site during
+     * the period.
+     */
+    atSite(site: string, start: Date, end: Date): boolean;
+    /**
+     * This general function is used to get the employee's workday for a date.  There are
+     * three possible types of request: general, actuals, and without leave.  It will
+     * provide the workday, if the employee will work or was working on the date.
+     * @param date The date object representing the date to check against.
+     * @param type The string value for the type of request to conduct:  general, actuals
+     * or noleaves.
+     * @param labor An array of Employee Labor Codes to compare against in the "actuals"
+     * type request.
+     * @returns A workday object for the work to be or was performed.  Will return undefined
+     * for a day not working or on leave.
+     */
+    getWorkday(date: Date, type?: string, labor?: EmployeeLaborCode[]): Workday | undefined;
+    /**
+     * This private function will provide the employee's workday based on assignment, then
+     * variation and lastly leaves.  Actual work hours are used for dates where they are
+     * before or on the date of the newest work record.
+     * @param date The date object used for comparison
+     * @returns A workday object or undefined for the employee's workday on the date.
+     */
+    private getWorkdayGeneral;
+    /**
+     * This private function provides the employee's workday for a particular date, but
+     * only provides leaves if the labor codes provided is a primary code for the
+     * employee.
+     * @param date The date object to compare for the workday.
+     * @param labor The charge number and extension array for comparison against the
+     *  employee's labor codes to determine if it is a primary code.
+     * @returns A workday object or undefined for the employee's workday on the date.
+     */
+    private getWorkdayActual;
+    /**
+     * This private function provides the employee's workday without leaves in consideration.
+     * @param date The date object used for comparison
+     * @returns A workday object or undefined for the employee's workday on the date.
+     */
+    private getWorkdayWOLeaves;
+    /**
+     * This function provides the employee's standard workday hours, which is based on a
+     * 40-hour work week divided by number of days worked in the work week.
+     * @param date The date object used to determine the assignment to use.
+     * @returns The float number value for the number of hours normal for each day's work.
+     */
+    getStandardWorkday(date: Date): number;
+    /**
+     * This function will add a new work assignment to the employee's assignment list.  It
+     * will assign the employee to a site and workcenter on a particular date.  It is
+     * assumed that this is the last assignment in the list, the end date is set to
+     * 12/31/9999.  It also sets the previous assignment to the end date of the start date
+     * value minus one day.
+     * @param site The string value for the site to assign the employee to.
+     * @param wkctr The string value for the workcenter to assign the employee to.
+     * @param start The date object used to mark the start of the assignment
+     */
+    addAssignment(site: string, wkctr: string, start: Date): void;
+    /**
+     * The function will remove a particular assignment from the assignment list
+     * @param id The numeric identifier for the assignment to remove.
+     */
+    removeAssignment(id: number): void;
+    /**
+     * This function will determine if a labor code (charge number and extension) is the
+     * employee's primary code for the date given.
+     * @param date The date object used for comparison.
+     * @param labor The labor code object to provide the charge number/extension for
+     * comparison.
+     * @returns A boolean value for whether or not the labor code is a primary one used
+     * by the employee.
+     */
+    isPrimaryCode(date: Date, labor: EmployeeLaborCode): boolean;
+    /**
+     * This function will find out if the employee is assigned a particular labor code
+     * @param chargeNumber The string value for the charge number to check for
+     * @param extension The string value for the extension to check for.
+     * @returns The boolean value for assignment of the charge number/extension.
+     */
+    hasLaborCode(chargeNumber: string, extension: string): boolean;
+    /**
+     * This function will check if the employee is assigned a particular charge number/
+     * extension on a particular date.
+     * @param date The date object used for the date to check.
+     * @param chgNo The string value for the charge number to check for
+     * @param extension The string value for the extension to check for.
+     * @returns The boolean value for assignment of the charge number/extension.
+     */
+    hasLaborCodeOnDate(date: Date, chgNo: string, ext: string): boolean;
+    /**
+     * This function is used to determine a workcenter and shift code for work during a
+     * period of time.
+     * @param start The date object for the start of the period.
+     * @param end The date object for the end of the period.
+     * @returns A workday object containing the workcenter and shift code to use for the
+     * period.
+     */
+    getAssignmentForPeriod(start: Date, end: Date): Workday;
+    /**
+     * This function will retrieve and provide the number of forecasted hours from this
+     * employee for a time period and labor code.
+     * @param labor The company labor code object for the labor codes to check against
+     * @param start The date object for the start of the period
+     * @param end The date object for the end of the period
+     * @param codes A list of compare code objects used for verifying correct codes and
+     * whether or not they are leave codes.
+     * @returns A numeric (float) value for the number of hours the employee is forecast.
+     */
+    getForecastHours(labor: LaborCode, start: Date, end: Date, codes: CompareWorkCode[]): number;
+    /**************************************************************************************
+     * Work Records section
+     **************************************************************************************/
+    /**
+     * This function will provide the total number of hours of actual work for the period
+     * given
+     * @param start The date object for the start of the period
+     * @param end The date object for the end of the period
+     * @param chgno (Optional) The string value for the charge number
+     * @param ext (Optional) The string value for the charge number extension
+     * @returns The numeric value for the total hours of actual work
+     */
+    getWorkedHours(start: Date, end: Date, chgno?: string, ext?: string): number;
+    /**
+     * This function will provide the date for the last work record in the object
+     * @returns A date object for the last worked day.
+     */
+    getLastWorkday(): Date;
+    /**
+     * This function will provide the number of modified time hours for a period of time.
+     * @param start The date object for the start of the period.
+     * @param end The date object for the end of the period.
+     * @returns The numeric (float) value for the number of hours of modified time.
+     */
+    getModTime(start: Date, end: Date): number;
+    hasModTime(start: Date, end: Date): boolean;
+    /**************************************************************************************
+     * Leave Balance Section - it provides the employee's starting leave balance and the
+     * number of hours provided for the year.
+     **************************************************************************************/
+    /**
+     * This function will add a new leave balance object to the leave balance list.  It will
+     * only add a new leave balance object if the object for the year doesn't already exist.
+     * @param year The numeric (int) value for the year the balances are for.
+     */
+    createLeaveBalance(year: number): void;
+    /**
+     * This function is used to update a leave balance object with a new annual year and
+     * carry over amount.
+     * @param year The numeric value for the year used as a key value
+     * @param annual The numeric value for the employee's annual leave amount in hours.
+     * @param carry The numeric value for the number of hours the employee brings forward
+     * to this year.
+     */
+    updateLeaveBalance(year: number, annual: number, carry: number): void;
+    /**
+     * This function will remove a leave balance from the employee's leave balance list.
+     * @param year The numeric value for the year of the leave balance (primary key).
+     */
+    deleteLeaveBalance(year: number): void;
+    /**
+     * This is the employee leave section.
+     */
+    /**
+     * This function will add a new leave day to the employee's leave list.  It first checks
+     * for a leave on the date and code given and will modify leave's other data.  If not
+     * found in the list, it will add the leave to the list, then sort the leaves.
+     * @param id The numeric value for the leave, normally zero for new leave
+     * @param date The date object to give the date the leave
+     * @param code The string value representing the work/leave code for this leave
+     * @param status The string value for the status of this leave.
+     * @param hours The numeric value for the number of hours (float)
+     * @param requestid The string value for the associated request reference, may be an
+     * empty string.
+     * @param holCode (Optional) A reference string for the holiday the leave is associated
+     * with.
+     */
+    addLeave(id: number, date: Date, code: string, status: string, hours: number, requestid: string, holCode?: string): void;
+    /**
+     * This function will update a single field within the leave, based on leave's identifier.
+     * @param id The numeric value for the leave.
+     * @param field The string value for the associated data member to update
+     * @param value The string value for the updated value.
+     * @returns The updated leave object.
+     */
+    updateLeave(id: number, field: string, value: string): Leave | undefined;
+    /**
+     * This function will remove a leave day from the employee's leave list, base on
+     * numeric identifier.
+     * @param id numeric value for the identifier.
+     */
+    deleteLeave(id: number): void;
+    /**
+     * This function will provide a total number of leave hours for a particular period of
+     * time (Actual Leave Only)
+     * @param start The date object for the start of the time period
+     * @param end The date object for the end of the time period
+     * @returns numeric (float) value for the total leave hours for the period
+     */
+    getLeaveHours(start: Date, end: Date): number;
+    /**
+     * This function will provide a total number of vacation/PTO leave hours for a
+     * particular period of time (Actual Leave Only)
+     * @param start The date object for the start of the time period
+     * @param end The date object for the end of the time period
+     * @returns numeric (float) value for the total leave hours for the period
+     */
+    getPTOHours(start: Date, end: Date): number;
+    /**
+     * This will be the Leave Request section
+     */
+    /**
+     * This function will create a new leave request for the employee
+     * @param start The date object for the start of the leave request period
+     * @param end The date object for the end of the leave request period
+     * @param code the string value for the code to the primary leave type to use
+     * @param comment The string vlue for any comment to use
+     * @returns The new leave request object or undefined if not created.
+     */
+    createLeaveRequest(start: Date, end: Date, code: string, comment: string): LeaveRequest | undefined;
+    /**
+     * This function is used to update a leave request of the employee, by identifier,
+     * field to update and the value to update to.
+     * @param id The string value representing the identifier
+     * @param field The string value for the field to update.
+     * @param value The string value to use in the update.
+     * @returns An interface of the consisting of a email message, leave request, and an
+     * error message.
+     */
+    updateLeaveRequest(id: string, field: string, value: string): ChangeLeaveRequestResponse;
+    /**
+     * This function is used to approve a requested leave request.  When approved it updates
+     * the leave list of the employee, plus if the request is a mod time request, it creates
+     * the variation for the mod time.
+     * @param id The string value for the identifier for the leave request.
+     * @param approver The string value for the identifier for the employee who approved
+     * this request.
+     * @param leavecodes A list of workcode associated with types of leaves.
+     * @returns A change leave request response containing any message to email and this
+     * leave request.
+     */
+    approveLeaveRequest(id: string, approver: string, leavecodes: Workcode[]): ChangeLeaveRequestResponse;
+    /**
+     * This function will remove a leave request from the employee's list, plus if the
+     * request has an approved status, it will remove any associated leaves and variations.
+     * @param id The string value for the identifier for the leave request.
+     */
+    deleteLeaveRequest(id: string): void;
+    /***************************************************************************************
+     * Employee's contact information section
+     **************************************************************************************/
+    /**
+     * This function will either add a new contact information or update one with the
+     * provided type id.
+     * @param typeid The numeric value for the type of contact information corresponding
+     * to the team's contact information types.
+     * @param value The string value for the contact information value
+     * @param sortid The numeric value for the sort order for this object, gotten from the
+     * team's contact information types.
+     */
+    addContactInfo(typeid: number, value: string, sortid: number): void;
+    /**
+     * This function will re-sort the employee's contact information based on the team's
+     * contact information types' sort order.
+     * @param teamcontacts A map of the team's contact information types sort order.
+     */
+    resortContactInfo(teamcontacts: Map<number, number>): void;
+    /**
+     * This function will remove an employee's contact information by type id.
+     * @param type The numeric value for the type of contact information to remove.
+     */
+    deleteContactInfoByType(type: number): void;
+    /**
+     * This function will remove an employee's contact information by identifier.
+     * @param id The numeric value for the identifier for the contact info.
+     */
+    deleteContactInfo(id: number): void;
+    /**
+     * This function is used to update for add a specialty to the employee's list.
+     * @param specid numeric value for the specialty identifier from the team's specialty
+     * list.
+     * @param qualified boolean value to signify if the employee is qualified in it
+     * @param sort numeric value for the sort position, copied from the team's specialty
+     * list.
+     */
+    addSpecialty(specid: number, qualified: boolean, sort: number): void;
+    /**
+     * This function will reassign the employee's specialties with the sort values for the
+     * team specialties, then re-sort them.
+     * @param teamspecs The Map of the team specialties sort number by specialty id.
+     */
+    resortSpecialties(teamspecs: Map<number, number>): void;
+    /**
+     * This function will remove an employee's specialty by identifier.
+     * @param id The numeric value for the employee's specialty identifier.
+     */
+    deleteSpecialty(id: number): void;
+    /**
+     * This function will remove an employee's specialty by specialty type
+     * @param type The numeric value associated with the team's specialty identifer.
+     */
+    deleteSpecialtyByType(type: number): void;
+    /**
+     * This function will provide a boolean answer as to whether the employee is qualified
+     * in a particular specialty skill.
+     * @param spec The numeric value for the specialty to search for.
+     * @returns boolean value for the employee's qualified to this skill.
+     */
+    hasSpecialty(spec: number): boolean;
+}