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.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.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class CreateUseCommand
040        extends BaseSimpleCommand<CreateUseForm> {
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.Use.name(), SecurityRoles.Create.name())
050                        )))
051                )));
052        
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("UseName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("UseTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
057                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
058                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
059                ));
060    }
061    
062    /** Creates a new instance of CreateUseCommand */
063    public CreateUseCommand(UserVisitPK userVisitPK, CreateUseForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = OfferResultFactory.getCreateUseResult();
070        var useTypeName = form.getUseTypeName();
071        var useType = UseTypeLogic.getInstance().getUseTypeByName(this, useTypeName);
072        Use use = null;
073
074        if(!hasExecutionErrors()) {
075            var useName = form.getUseName();
076            var isDefault = Boolean.valueOf(form.getIsDefault());
077            var sortOrder = Integer.valueOf(form.getSortOrder());
078            var description = form.getDescription();
079
080            use = UseLogic.getInstance().createUse(this, useName, useType, isDefault, sortOrder,
081                    getPreferredLanguage(), description, getPartyPK());
082        }
083
084        if(use != null) {
085            result.setUseName(use.getLastDetail().getUseName());
086            result.setEntityRef(use.getPrimaryKey().getEntityRef());
087        }
088
089        return result;
090    }
091    
092}