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.CreateNameSuffixForm;
020import com.echothree.control.user.party.common.result.CreateNameSuffixResult;
021import com.echothree.control.user.party.common.result.PartyResultFactory;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.data.party.server.entity.NameSuffix;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.Arrays;
031import java.util.Collections;
032import java.util.List;
033
034public class CreateNameSuffixCommand
035        extends BaseSimpleCommand<CreateNameSuffixForm> {
036
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038
039    static {
040        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
041                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
042                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
043                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
044                ));
045    }
046    
047    /** Creates a new instance of CreateNameSuffixCommand */
048    public CreateNameSuffixCommand(UserVisitPK userVisitPK, CreateNameSuffixForm form) {
049        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
050    }
051    
052    @Override
053    protected BaseResult execute() {
054        CreateNameSuffixResult result = PartyResultFactory.getCreateNameSuffixResult();
055        var description = form.getDescription();
056        var isDefault = Boolean.valueOf(form.getIsDefault());
057        var sortOrder = Integer.valueOf(form.getSortOrder());
058        var partyControl = Session.getModelController(PartyControl.class);
059        
060        NameSuffix nameSuffix = partyControl.createNameSuffix(description, isDefault, sortOrder, getPartyPK());
061        result.setNameSuffixId(nameSuffix.getPrimaryKey().getEntityId().toString());
062        
063        return result;
064    }
065    
066}