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.GetBatchAliasesForm;
020import com.echothree.control.user.batch.common.result.BatchResultFactory;
021import com.echothree.control.user.batch.common.result.GetBatchAliasesResult;
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.BatchType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.user.server.entity.UserVisit;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetBatchAliasesCommand
044        extends BaseSimpleCommand<GetBatchAliasesForm> {
045    
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
050                new FieldDefinition("BatchTypeName", FieldType.ENTITY_NAME, true, null, null),
051                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, true, null, null)
052                ));
053    }
054    
055    /** Creates a new instance of GetBatchAliasesCommand */
056    public GetBatchAliasesCommand(UserVisitPK userVisitPK, GetBatchAliasesForm form) {
057        super(userVisitPK, form, new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(BatchAliasUtil.getInstance().getSecurityRoleGroupNameByBatchTypeSpec(form), SecurityRoles.List.name())
061                        )))
062                ))), FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var batchControl = Session.getModelController(BatchControl.class);
068        GetBatchAliasesResult result = BatchResultFactory.getGetBatchAliasesResult();
069        String batchTypeName = form.getBatchTypeName();
070        BatchType batchType = batchControl.getBatchTypeByName(batchTypeName);
071
072        if(batchType != null) {
073            String batchName = form.getBatchName();
074            Batch batch = batchControl.getBatchByName(batchType, batchName);
075
076            if(batch != null) {
077                UserVisit userVisit = getUserVisit();
078
079                result.setBatch(batchControl.getBatchTransfer(userVisit, batch));
080                result.setBatchAliases(batchControl.getBatchAliasTransfersByBatch(userVisit, batch));
081            } else {
082                addExecutionError(ExecutionErrors.UnknownBatchName.name(), batchTypeName, batchName);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownBatchTypeName.name(), batchTypeName);
086        }
087
088        return result;
089    }
090    
091}