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