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.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.model.control.content.server.logic.ContentLogic;
022import com.echothree.model.control.document.server.control.DocumentControl;
023import com.echothree.model.control.document.server.logic.DocumentLogic;
024import com.echothree.model.data.document.server.entity.PartyDocument;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032import javax.inject.Inject;
033
034@Dependent
035public class GetPartyDocumentCommand
036        extends BaseSingleEntityCommand<PartyDocument, GetPartyDocumentForm> {
037    
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = List.of(
042                new FieldDefinition("DocumentName", FieldType.ENTITY_NAME, false, null, null),
043                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
044                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
045                new FieldDefinition("Referrer", FieldType.URL, false, null, null)
046        );
047    }
048
049    @Inject
050    DocumentControl documentControl;
051
052    @Inject
053    ContentLogic contentLogic;
054
055    @Inject
056    DocumentLogic documentLogic;
057
058    /** Creates a new instance of GetPartyDocumentCommand */
059    public GetPartyDocumentCommand() {
060        super(null, FORM_FIELD_DEFINITIONS, true);
061    }
062
063    @Override
064    protected PartyDocument getEntity() {
065        PartyDocument partyDocument = null;
066
067        contentLogic.checkReferrer(this, form.getReferrer());
068
069        if(!hasExecutionErrors()) {
070            var document = documentLogic.getDocumentByUniversalSpec(this, form);
071
072            if(!hasExecutionErrors()) {
073                partyDocument = documentControl.getPartyDocumentByDocument(document);
074
075                if(partyDocument == null) {
076                    addExecutionError(ExecutionErrors.UnknownPartyDocument.name(),
077                            document.getLastDetail().getDocumentName());
078                }
079            }
080        }
081
082        return partyDocument;
083    }
084
085    @Override
086    protected BaseResult getResult(PartyDocument partyDocument) {
087        var result = DocumentResultFactory.getGetPartyDocumentResult();
088
089        if(partyDocument != null) {
090            result.setPartyDocument(documentControl.getPartyDocumentTransfer(getUserVisit(), partyDocument));
091        }
092
093        return result;
094    }
095    
096}