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.contact.server.command;
018
019import com.echothree.control.user.contact.common.form.GetContactMechanismChoicesForm;
020import com.echothree.control.user.contact.common.result.ContactResultFactory;
021import com.echothree.control.user.contact.common.result.GetContactMechanismChoicesResult;
022import com.echothree.model.control.contact.server.control.ContactControl;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.data.contact.server.entity.ContactMechanismType;
025import com.echothree.model.data.party.server.entity.Party;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetContactMechanismChoicesCommand
038        extends BaseSimpleCommand<GetContactMechanismChoicesForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("ContactMechanismTypeName", FieldType.ENTITY_NAME, false, null, null),
046                new FieldDefinition("DefaultContactMechanismChoice", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
048                ));
049    }
050    
051    /** Creates a new instance of GetContactMechanismChoicesCommand */
052    public GetContactMechanismChoicesCommand(UserVisitPK userVisitPK, GetContactMechanismChoicesForm form) {
053        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
054    }
055    
056    @Override
057    protected BaseResult execute() {
058        var partyControl = Session.getModelController(PartyControl.class);
059        GetContactMechanismChoicesResult result = ContactResultFactory.getGetContactMechanismChoicesResult();
060        String partyName = form.getPartyName();
061        Party party = partyControl.getPartyByName(partyName);
062        
063        if(party != null) {
064            var contactControl = Session.getModelController(ContactControl.class);
065            String contactMechanismTypeName = form.getContactMechanismTypeName();
066            ContactMechanismType contactMechanismType = contactMechanismTypeName == null ? null : contactControl.getContactMechanismTypeByName(contactMechanismTypeName);
067            
068            if(contactMechanismTypeName == null || contactMechanismType != null) {
069                String defaultContactMechanismChoice = form.getDefaultContactMechanismChoice();
070                boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
071                
072                result.setContactMechanismChoices(contactMechanismType == null ? contactControl.getContactMechanismChoicesByParty(party, defaultContactMechanismChoice, getPreferredLanguage(), allowNullChoice)
073                        : contactControl.getContactMechanismChoicesByPartyAndContactMechanismType(party, contactMechanismType, defaultContactMechanismChoice, getPreferredLanguage(), allowNullChoice));
074            } else {
075                addExecutionError(ExecutionErrors.UnknownContactMechanismTypeName.name(), contactMechanismType);
076            }
077        } else {
078            addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
079        }
080        
081        return result;
082    }
083    
084}