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.CreateUseNameElementForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.model.control.offer.server.logic.UseNameElementLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class CreateUseNameElementCommand
039        extends BaseSimpleCommand<CreateUseNameElementForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.UseNameElement.name(), SecurityRoles.Create.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("Offset", FieldType.UNSIGNED_INTEGER, true, null, null),
055                new FieldDefinition("Length", FieldType.UNSIGNED_INTEGER, true, null, null),
056                new FieldDefinition("ValidationPattern", FieldType.REGULAR_EXPRESSION, false, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058        );
059    }
060
061    @Inject
062    UseNameElementLogic useNameElementLogic;
063
064    
065    /** Creates a new instance of CreateUseNameElementCommand */
066    public CreateUseNameElementCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var result = OfferResultFactory.getCreateUseNameElementResult();
073        var useNameElementName = form.getUseNameElementName();
074        var offset = Integer.valueOf(form.getOffset());
075        var length = Integer.valueOf(form.getLength());
076        var validationPattern = form.getValidationPattern();
077        var description = form.getDescription();
078
079        var useNameElement = useNameElementLogic.createUseNameElement(this,
080                useNameElementName, offset, length, validationPattern, getPreferredLanguage(), description,
081                getPartyPK());
082
083        if(useNameElement != null && !hasExecutionErrors()) {
084            result.setUseNameElementName(useNameElement.getLastDetail().getUseNameElementName());
085            result.setEntityRef(useNameElement.getPrimaryKey().getEntityRef());
086        }
087
088        return result;
089    }
090    
091}