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