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.offer.server.command;
018
019import com.echothree.control.user.offer.common.form.CreateUseForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.model.control.offer.server.logic.UseLogic;
022import com.echothree.model.control.offer.server.logic.UseTypeLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.offer.server.entity.Use;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateUseCommand
041        extends BaseSimpleCommand<CreateUseForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Use.name(), SecurityRoles.Create.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("UseName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("UseTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060        );
061    }
062
063    @Inject
064    UseLogic useLogic;
065
066    @Inject
067    UseTypeLogic useTypeLogic;
068
069    
070    /** Creates a new instance of CreateUseCommand */
071    public CreateUseCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var result = OfferResultFactory.getCreateUseResult();
078        var useTypeName = form.getUseTypeName();
079        var useType = useTypeLogic.getUseTypeByName(this, useTypeName);
080        Use use = null;
081
082        if(!hasExecutionErrors()) {
083            var useName = form.getUseName();
084            var isDefault = Boolean.valueOf(form.getIsDefault());
085            var sortOrder = Integer.valueOf(form.getSortOrder());
086            var description = form.getDescription();
087
088            use = useLogic.createUse(this, useName, useType, isDefault, sortOrder,
089                    getPreferredLanguage(), description, getPartyPK());
090        }
091
092        if(use != null) {
093            result.setUseName(use.getLastDetail().getUseName());
094            result.setEntityRef(use.getPrimaryKey().getEntityRef());
095        }
096
097        return result;
098    }
099    
100}