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.GetGenderForm;
020import com.echothree.control.user.party.common.result.GetGenderResult;
021import com.echothree.control.user.party.common.result.PartyResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.data.party.server.entity.Gender;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.Arrays;
033import java.util.Collections;
034import java.util.List;
035
036public class GetGenderCommand
037        extends BaseSimpleCommand<GetGenderForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043            new FieldDefinition("GenderName", FieldType.ENTITY_NAME, true, null, null)
044        ));
045    }
046    
047    /** Creates a new instance of GetGenderCommand */
048    public GetGenderCommand(UserVisitPK userVisitPK, GetGenderForm form) {
049        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
050    }
051    
052    @Override
053    protected BaseResult execute() {
054        var partyControl = Session.getModelController(PartyControl.class);
055        GetGenderResult result = PartyResultFactory.getGetGenderResult();
056        String genderName = form.getGenderName();
057        Gender gender = partyControl.getGenderByName(genderName);
058        
059        if(gender != null) {
060            result.setGender(partyControl.getGenderTransfer(getUserVisit(), gender));
061            
062            sendEvent(gender.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
063        } else {
064            addExecutionError(ExecutionErrors.UnknownGenderName.name(), genderName);
065        }
066        
067        return result;
068    }
069    
070}