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.content.server.command;
018
019import com.echothree.control.user.content.common.form.GetContentCollectionForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.content.server.control.ContentControl;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.data.content.server.entity.ContentCollection;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033
034@Dependent
035public class GetContentCollectionCommand
036        extends BaseSingleEntityCommand<ContentCollection, GetContentCollectionForm> {
037    
038    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null)
044                );
045    }
046    
047    /** Creates a new instance of GetContentCollectionCommand */
048    public GetContentCollectionCommand() {
049        super(null, FORM_FIELD_DEFINITIONS, true);
050    }
051    
052    @Override
053    protected ContentCollection getEntity() {
054        var contentControl = Session.getModelController(ContentControl.class);
055        var contentCollectionName = form.getContentCollectionName();
056        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
057        
058        if(contentCollection != null) {
059            sendEvent(contentCollection.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
060        } else {
061            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
062        }
063        
064        return contentCollection;
065    }
066    
067    @Override
068    protected BaseResult getResult(ContentCollection contentCollection) {
069        var result = ContentResultFactory.getGetContentCollectionResult();
070        
071        if(contentCollection != null) {
072            var contentControl = Session.getModelController(ContentControl.class);
073    
074            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
075        }
076        
077        return result;
078    }
079    
080}