org.apereo.portlet.hr.model.timereporting.PayPeriodDailyLeaveTimeSummary.java Source code

Introduction

Here is the source code for org.apereo.portlet.hr.model.timereporting.PayPeriodDailyLeaveTimeSummary.java

Source

/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a
 * copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apereo.portlet.hr.model.timereporting;

import java.util.List;
import java.util.Set;

import org.joda.time.LocalDate;

/**
 * Statement of Leave Reported for each day in a pay period
 *
 * @author James Wennmacher, jwennmacher@unicon.net
 */

public class PayPeriodDailyLeaveTimeSummary {

    /**
     * Start date of the pay period.
     */
    LocalDate payPeriodStart;

    /**
     * End date of the pay period.
     */
    LocalDate payPeriodEnd;

    /**
     * List of job descriptions available to the employee.  The order of the list determines the order the job
     * descriptions are presented on the UI.  There should only be entries for job codes that are in the other members of this class.
     */
    List<JobDescription> jobDescriptions;

    /**
     * Set of the job codes that are display-only, for example holidays, summaries of hours worked, or periods
     * of time that the user is not allowed to enter or update data for.
     */
    Set<Integer> displayOnlyJobCodes;

    /**
     * Unordered list of leave information for each day in the pay period.  This list may not be fully
     * populated for all days in the pay period.
     */
    List<TimePeriodEntry> timePeriodEntries;

    public PayPeriodDailyLeaveTimeSummary() {
    }

    public PayPeriodDailyLeaveTimeSummary(LocalDate payPeriodStart, LocalDate payPeriodEnd,
            List<JobDescription> jobDescriptions, Set<Integer> displayOnlyJobCodes,
            List<TimePeriodEntry> timePeriodEntries) {
        if (payPeriodEnd.isBefore(payPeriodStart)) {
            throw new IllegalArgumentException("Pay period end cannot be earlier than pay period start");
        }
        this.payPeriodStart = payPeriodStart;
        this.payPeriodEnd = payPeriodEnd;
        this.jobDescriptions = jobDescriptions;
        this.displayOnlyJobCodes = displayOnlyJobCodes;
        this.timePeriodEntries = timePeriodEntries;
    }

    public LocalDate getPayPeriodStart() {
        return payPeriodStart;
    }

    public void setPayPeriodStart(LocalDate payPeriodStart) {
        this.payPeriodStart = payPeriodStart;
    }

    public LocalDate getPayPeriodEnd() {
        return payPeriodEnd;
    }

    public void setPayPeriodEnd(LocalDate payPeriodEnd) {
        this.payPeriodEnd = payPeriodEnd;
    }

    public List<JobDescription> getJobDescriptions() {
        return jobDescriptions;
    }

    public void setJobDescriptions(List<JobDescription> jobDescriptions) {
        this.jobDescriptions = jobDescriptions;
    }

    public Set<Integer> getDisplayOnlyJobCodes() {
        return displayOnlyJobCodes;
    }

    public void setDisplayOnlyJobCodes(Set<Integer> displayOnlyJobCodes) {
        this.displayOnlyJobCodes = displayOnlyJobCodes;
    }

    public List<TimePeriodEntry> getTimePeriodEntries() {
        return timePeriodEntries;
    }

    public void setTimePeriodEntries(List<TimePeriodEntry> timePeriodEntries) {
        this.timePeriodEntries = timePeriodEntries;
    }
}