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.GetPostalAddressLineElementsForm;
020import com.echothree.control.user.contact.common.result.ContactResultFactory;
021import com.echothree.control.user.contact.common.result.GetPostalAddressLineElementsResult;
022import com.echothree.model.control.contact.server.control.ContactControl;
023import com.echothree.model.data.contact.server.entity.PostalAddressFormat;
024import com.echothree.model.data.contact.server.entity.PostalAddressLine;
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 GetPostalAddressLineElementsCommand
037        extends BaseSimpleCommand<GetPostalAddressLineElementsForm> {
038
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043                new FieldDefinition("PostalAddressFormatName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("PostalAddressLineSortOrder", FieldType.SIGNED_INTEGER, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetPostalAddressLineElementsCommand */
049    public GetPostalAddressLineElementsCommand(UserVisitPK userVisitPK, GetPostalAddressLineElementsForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var contactControl = Session.getModelController(ContactControl.class);
056        GetPostalAddressLineElementsResult result = ContactResultFactory.getGetPostalAddressLineElementsResult();
057        String postalAddressFormatName = form.getPostalAddressFormatName();
058        PostalAddressFormat postalAddressFormat = contactControl.getPostalAddressFormatByName(postalAddressFormatName);
059        
060        if(postalAddressFormat != null) {
061            Integer postalAddressLineSortOrder = Integer.valueOf(form.getPostalAddressLineSortOrder());
062            PostalAddressLine postalAddressLine = contactControl.getPostalAddressLine(postalAddressFormat, postalAddressLineSortOrder);
063            
064            result.setPostalAddressFormat(contactControl.getPostalAddressFormatTransfer(getUserVisit(), postalAddressFormat));
065            
066            if(postalAddressLine != null) {
067                result.setPostalAddressLine(contactControl.getPostalAddressLineTransfer(getUserVisit(), postalAddressLine));
068                result.setPostalAddressLineElements(contactControl.getPostalAddressLineElementTransfersByPostalAddressLine(getUserVisit(), postalAddressLine));
069            } else {
070                addExecutionError(ExecutionErrors.UnknownPostalAddressLine.name(), postalAddressLineSortOrder);
071            }
072        } else {
073            addExecutionError(ExecutionErrors.UnknownPostalAddressFormatName.name(), postalAddressFormatName);
074        }
075        
076        return result;
077    }
078    
079}