001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetPostalAddressFormatForm;
020import com.echothree.control.user.contact.common.result.ContactResultFactory;
021import com.echothree.model.control.contact.server.control.ContactControl;
022import com.echothree.model.data.contact.server.entity.PostalAddressFormat;
023import com.echothree.util.common.command.BaseResult;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.server.control.BaseSingleEntityCommand;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetPostalAddressFormatCommand
034        extends BaseSingleEntityCommand<PostalAddressFormat, GetPostalAddressFormatForm> {
035
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040                new FieldDefinition("PostalAddressFormatName", FieldType.ENTITY_NAME, true, null, null)
041        );
042    }
043
044    @Inject
045    ContactControl contactControl;
046
047    /** Creates a new instance of GetPostalAddressFormatCommand */
048    public GetPostalAddressFormatCommand() {
049        super(null, FORM_FIELD_DEFINITIONS, true);
050    }
051
052    @Override
053    protected PostalAddressFormat getEntity() {
054        var postalAddressFormatName = form.getPostalAddressFormatName();
055        var postalAddressFormat = contactControl.getPostalAddressFormatByName(postalAddressFormatName);
056
057        if(postalAddressFormat == null) {
058            addExecutionError(ExecutionErrors.UnknownPostalAddressFormatName.name(), postalAddressFormatName);
059        }
060
061        return postalAddressFormat;
062    }
063
064    @Override
065    protected BaseResult getResult(PostalAddressFormat postalAddressFormat) {
066        var result = ContactResultFactory.getGetPostalAddressFormatResult();
067
068        if(postalAddressFormat != null) {
069            result.setPostalAddressFormat(contactControl.getPostalAddressFormatTransfer(getUserVisit(), postalAddressFormat));
070        }
071
072        return result;
073    }
074
075}