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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.form.GetWorkflowEntranceSelectorForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.control.workflow.server.logic.WorkflowEntranceLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntranceSelector;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetWorkflowEntranceSelectorCommand
041        extends BaseSingleEntityCommand<WorkflowEntranceSelector, GetWorkflowEntranceSelectorForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntrance.name(), SecurityRoles.Selector.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of GetWorkflowEntranceSelectorCommand */
062    public GetWorkflowEntranceSelectorCommand(UserVisitPK userVisitPK, GetWorkflowEntranceSelectorForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected WorkflowEntranceSelector getEntity() {
068        var workflowName = form.getWorkflowName();
069        var workflowEntranceName = form.getWorkflowEntranceName();
070        var selectorName = form.getSelectorName();
071
072        return WorkflowEntranceLogic.getInstance().getWorkflowEntranceSelectorByName(this, workflowName, workflowEntranceName,
073                selectorName);
074    }
075
076    @Override
077    protected BaseResult getResult(WorkflowEntranceSelector entity) {
078        var result = WorkflowResultFactory.getGetWorkflowEntranceSelectorResult();
079
080        if(entity != null) {
081            var workflowControl = Session.getModelController(WorkflowControl.class);
082
083            result.setWorkflowEntranceSelector(workflowControl.getWorkflowEntranceSelectorTransfer(getUserVisit(), entity));
084        }
085
086        return result;
087    }
088
089}