/*
 * ICESOFT COMMERCIAL SOURCE CODE LICENSE V 1.1
 *
 * The contents of this file are subject to the ICEsoft Commercial Source
 * Code License Agreement V1.1 (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.icesoft.com/license/commercial-source-v1.1.html
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations under
 * the License.
 *
 * Copyright 2009-2015 ICEsoft Technologies Canada, Corp. All Rights Reserved.
 */
package com.icesoft.faces.facelets.component.names;

import javax.faces.bean.ApplicationScoped;
import javax.faces.bean.ManagedBean;
import java.io.Serializable;

/**
 * <p>Class containing static names of various f:param names, so they are pulled
 * from one place. </p>
 *
 * @author ICEsoft Technologies Inc.
 */
@ApplicationScoped
@ManagedBean(name = "ParameterNames")
public class ParameterNames implements Serializable {

    /**
     * Calendar view types are used by the main tabset that changes the
     * view from day, week, month, year.  This context param is used to fetch
     * form the action event which tab was clicked.
     */
    public static final String CALENDAR_VIEW_TYPE = "calendarViewType";

    /**
     * These params are used from, the month calendar views to specify
     * the year/month/day of the selected day. These values can then be used
     * to update the currenCalendarCursor so we are on the correct date when
     * going to a new view.
     */
    public static final String YEAR_DATE_CURSOR = "yearCursor";
    public static final String MONTH_DATE_CURSOR = "monthCursor";
    public static final String DAY_DATE_CURSOR = "dayCursor";

    /**
     * Parameter for passing an eventID into a action or
     * actionListener.  General use is to setup a view for id in question.
     */
    public static final String EVENT_ID = "eventId";

    public String getCalendarViewType() {
        return CALENDAR_VIEW_TYPE;
    }

    public String getYearDateCursor() {
        return YEAR_DATE_CURSOR;
    }

    public String getMonthDateCursor() {
        return MONTH_DATE_CURSOR;
    }

    public String getDayDateCursor() {
        return DAY_DATE_CURSOR;
    }

    public String getEventId() {
        return EVENT_ID;
    }
}