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.GetPartyDocumentForm;
020import com.echothree.control.user.document.common.result.DocumentResultFactory;
021import com.echothree.control.user.document.common.result.GetPartyDocumentResult;
022import com.echothree.model.control.content.server.logic.ContentLogic;
023import com.echothree.model.control.document.server.control.DocumentControl;
024import com.echothree.model.data.document.server.entity.Document;
025import com.echothree.model.data.document.server.entity.PartyDocument;
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.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetPartyDocumentCommand
038        extends BaseSimpleCommand<GetPartyDocumentForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("DocumentName", FieldType.ENTITY_NAME, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetPartyDocumentCommand */
049    public GetPartyDocumentCommand(UserVisitPK userVisitPK, GetPartyDocumentForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        GetPartyDocumentResult result = DocumentResultFactory.getGetPartyDocumentResult();
056        ContentLogic.getInstance().checkReferrer(this, form.getReferrer());
057        
058        if(!hasExecutionErrors()) {
059            var documentControl = Session.getModelController(DocumentControl.class);
060            String documentName = form.getDocumentName();
061            Document document = documentControl.getDocumentByName(documentName);
062
063            if(document != null) {
064                PartyDocument partyDocument = documentControl.getPartyDocumentByDocument(document);
065
066                if(partyDocument != null) {
067                    result.setPartyDocument(documentControl.getPartyDocumentTransfer(getUserVisit(), partyDocument));
068                } else {
069                    addExecutionError(ExecutionErrors.UnknownPartyDocument.name(), documentName);
070                }
071            } else {
072                addExecutionError(ExecutionErrors.UnknownDocumentName.name(), documentName);
073            }
074        }
075
076        return result;
077    }
078    
079}