org.efaps.esjp.admin.user.TimeZoneUI.java Source code

Introduction

Here is the source code for org.efaps.esjp.admin.user.TimeZoneUI.java

Source

/*
 * Copyright 2003 - 2016 The eFaps Team
 *
 * Licensed 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.efaps.esjp.admin.user;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;

import org.efaps.admin.event.Parameter;
import org.efaps.admin.event.Parameter.ParameterValues;
import org.efaps.admin.event.Return;
import org.efaps.admin.event.Return.ReturnValues;
import org.efaps.admin.program.esjp.EFapsApplication;
import org.efaps.admin.program.esjp.EFapsUUID;
import org.efaps.ci.CIAdminUser;
import org.efaps.db.Instance;
import org.efaps.db.PrintQuery;
import org.efaps.esjp.common.uiform.Field;
import org.efaps.esjp.common.uiform.Field_Base.DropDownPosition;
import org.efaps.util.EFapsException;
import org.joda.time.DateTimeZone;

/**
 * ESJP is used to get the value, and to render the fields for timezone.
 *
 * @author The eFaps Team
 */
@EFapsUUID("122112fd-9bd8-4855-8948-6837272195eb")
@EFapsApplication("eFaps-Kernel")
public class TimeZoneUI {

    /**
     * Method is called from within the form Admin_User_Person to retieve the
     * value for the timezone.
     *
     * @param _parameter Parameters as passed from eFaps
     * @return Return containing the timezone
     * @throws EFapsException on error
     */
    public Return getTimeZoneFieldValue(final Parameter _parameter) throws EFapsException {
        final Return retVal = new Return();

        final Instance instance = (Instance) _parameter.get(ParameterValues.CALL_INSTANCE);
        // set a default value
        String currentTz = "UTC";

        if (instance != null && instance.getType().getUUID().equals(CIAdminUser.Person.uuid)) {
            final PrintQuery print = new PrintQuery(instance);
            print.addAttribute(CIAdminUser.Person.TimeZone);
            if (print.execute()) {
                currentTz = print.<String>getAttribute(CIAdminUser.Person.TimeZone);
            }
        }
        retVal.put(ReturnValues.VALUES, getValues(_parameter, currentTz));
        return retVal;
    }

    /**
     * Method is called from within the form Admin_User_SettingChgForm to render
     * a drop down field with all Timezones.
     *
     * @param _parameter Parameters as passed from eFaps
     * @return Return containing a drop down
     * @throws EFapsException on error
     */
    public Return get4Setting(final Parameter _parameter) throws EFapsException {
        final Return retVal = new Return();
        retVal.put(ReturnValues.VALUES, getValues(_parameter, null));
        return retVal;
    }

    /**
     * Method to build a drop down field for html containing all timezone.
     *
     * @param _parameter Parameter as passed by the eFaps API
     * @param _currentTz the current tz
     * @return StringBuilder with drop down
     * @throws EFapsException on error
     */
    private List<DropDownPosition> getValues(final Parameter _parameter, final String _currentTz)
            throws EFapsException {
        final List<DropDownPosition> ret = new ArrayList<DropDownPosition>();
        final Set<?> timezoneIds = DateTimeZone.getAvailableIDs();
        final Field field = new Field();
        for (final Object timezoneId : timezoneIds) {
            final DropDownPosition val = field.getDropDownPosition(_parameter, timezoneId, timezoneId);
            val.setSelected(timezoneId.equals(_currentTz));
            ret.add(val);
        }
        Collections.sort(ret, new Comparator<DropDownPosition>() {

            @SuppressWarnings("unchecked")
            @Override
            public int compare(final DropDownPosition _arg0, final DropDownPosition _arg1) {
                return _arg0.getOrderValue().compareTo(_arg1.getOrderValue());
            }
        });
        return ret;
    }
}