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.batch.server.command;
018
019import com.echothree.control.user.batch.common.form.GetBatchAliasForm;
020import com.echothree.control.user.batch.common.result.BatchResultFactory;
021import com.echothree.control.user.batch.common.result.GetBatchAliasResult;
022import com.echothree.control.user.batch.server.command.util.BatchAliasUtil;
023import com.echothree.model.control.batch.server.control.BatchControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.batch.server.entity.Batch;
027import com.echothree.model.data.batch.server.entity.BatchAlias;
028import com.echothree.model.data.batch.server.entity.BatchAliasType;
029import com.echothree.model.data.batch.server.entity.BatchType;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetBatchAliasCommand
045        extends BaseSimpleCommand<GetBatchAliasForm> {
046    
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
051                new FieldDefinition("BatchTypeName", FieldType.ENTITY_NAME, true, null, null),
052                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("BatchAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
054                ));
055    }
056    
057    /** Creates a new instance of GetBatchAliasCommand */
058    public GetBatchAliasCommand(UserVisitPK userVisitPK, GetBatchAliasForm form) {
059        super(userVisitPK, form, new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
062                        new SecurityRoleDefinition(BatchAliasUtil.getInstance().getSecurityRoleGroupNameByBatchTypeSpec(form), SecurityRoles.Review.name())
063                        )))
064                ))), FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var batchControl = Session.getModelController(BatchControl.class);
070        GetBatchAliasResult result = BatchResultFactory.getGetBatchAliasResult();
071        String batchTypeName = form.getBatchTypeName();
072        BatchType batchType = batchControl.getBatchTypeByName(batchTypeName);
073
074        if(batchType != null) {
075            String batchName = form.getBatchName();
076            Batch batch = batchControl.getBatchByName(batchType, batchName);
077
078            if(batch != null) {
079                String batchAliasTypeName = form.getBatchAliasTypeName();
080                BatchAliasType batchAliasType = batchControl.getBatchAliasTypeByName(batchType, batchAliasTypeName);
081
082                if(batchAliasType != null) {
083                    BatchAlias batchAlias = batchControl.getBatchAlias(batch, batchAliasType);
084
085                    if(batchAlias != null) {
086                        result.setBatchAlias(batchControl.getBatchAliasTransfer(getUserVisit(), batchAlias));
087                    } else {
088                        addExecutionError(ExecutionErrors.UnknownBatchAlias.name(), batchName, batchAliasTypeName);
089                    }
090                } else {
091                    addExecutionError(ExecutionErrors.UnknownBatchAliasTypeName.name(), batchTypeName, batchAliasTypeName);
092                }
093            } else {
094                addExecutionError(ExecutionErrors.UnknownBatchName.name(), batchTypeName, batchName);
095            }
096        } else {
097            addExecutionError(ExecutionErrors.UnknownBatchTypeName.name(), batchTypeName);
098        }
099
100        return result;
101    }
102    
103}