001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.party.server.command;
018
019import com.echothree.control.user.party.common.form.GetDateTimeFormatChoicesForm;
020import com.echothree.control.user.party.common.result.GetDateTimeFormatChoicesResult;
021import com.echothree.control.user.party.common.result.PartyResultFactory;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.Arrays;
030import java.util.Collections;
031import java.util.List;
032
033public class GetDateTimeFormatChoicesCommand
034        extends BaseSimpleCommand<GetDateTimeFormatChoicesForm> {
035    
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
041            new FieldDefinition("DefaultDateTimeFormatChoice", FieldType.ENTITY_NAME, false, null, null),
042            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
043        ));
044    }
045    
046    /** Creates a new instance of GetDateTimeFormatChoicesCommand */
047    public GetDateTimeFormatChoicesCommand(UserVisitPK userVisitPK, GetDateTimeFormatChoicesForm form) {
048        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var partyControl = Session.getModelController(PartyControl.class);
054        GetDateTimeFormatChoicesResult result = PartyResultFactory.getGetDateTimeFormatChoicesResult();
055        String defaultDateTimeFormatChoice = form.getDefaultDateTimeFormatChoice();
056        boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
057        
058        result.setDateTimeFormatChoices(partyControl.getDateTimeFormatChoices(defaultDateTimeFormatChoice, getPreferredLanguage(),
059                allowNullChoice));
060        
061        return result;
062    }
063    
064}