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.document.server.command;
018
019import com.echothree.control.user.document.common.form.SetDefaultPartyDocumentForm;
020import com.echothree.model.control.document.server.control.DocumentControl;
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.data.document.server.entity.Document;
025import com.echothree.model.data.document.server.value.PartyDocumentValue;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
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 com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class SetDefaultPartyDocumentCommand
041        extends BaseSimpleCommand<SetDefaultPartyDocumentForm> {
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.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PartyDocument.name(), SecurityRoles.Edit.name())
050                        )))
051                )));
052        
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("DocumentName", FieldType.ENTITY_NAME, true, null, null)
055                ));
056    }
057    
058    /** Creates a new instance of SetDefaultPartyDocumentCommand */
059    public SetDefaultPartyDocumentCommand(UserVisitPK userVisitPK, SetDefaultPartyDocumentForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var documentControl = Session.getModelController(DocumentControl.class);
066        String documentName = form.getDocumentName();
067        Document document = documentControl.getDocumentByNameForUpdate(documentName);
068        
069        if(document != null) {
070            PartyDocumentValue partyDocumentValue = documentControl.getPartyDocumentValueForUpdate(document);
071
072            if(partyDocumentValue != null) {
073                partyDocumentValue.setIsDefault(Boolean.TRUE);
074                documentControl.updatePartyDocumentFromValue(partyDocumentValue, getPartyPK());
075            } else {
076                addExecutionError(ExecutionErrors.UnknownPartyDocument.name(), documentName);
077            }
078        } else {
079            addExecutionError(ExecutionErrors.UnknownDocumentName.name(), documentName);
080        }
081        
082        return null;
083    }
084    
085}