001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
032import java.util.Collections;
033import java.util.List;
034import javax.enterprise.context.RequestScoped;
035
036@RequestScoped
037public class GetContentCollectionCommand
038        extends BaseSingleEntityCommand<ContentCollection, GetContentCollectionForm> {
039    
040    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null)
046                ));
047    }
048    
049    /** Creates a new instance of GetContentCollectionCommand */
050    public GetContentCollectionCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, true);
052    }
053    
054    @Override
055    protected ContentCollection getEntity() {
056        var contentControl = Session.getModelController(ContentControl.class);
057        var contentCollectionName = form.getContentCollectionName();
058        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
059        
060        if(contentCollection != null) {
061            sendEvent(contentCollection.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
062        } else {
063            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
064        }
065        
066        return contentCollection;
067    }
068    
069    @Override
070    protected BaseResult getResult(ContentCollection contentCollection) {
071        var result = ContentResultFactory.getGetContentCollectionResult();
072        
073        if(contentCollection != null) {
074            var contentControl = Session.getModelController(ContentControl.class);
075    
076            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
077        }
078        
079        return result;
080    }
081    
082}