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.GetContentCollectionsForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.control.user.content.common.result.GetContentCollectionsResult;
022import com.echothree.model.control.content.server.control.ContentControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.content.server.entity.ContentCollection;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collection;
037import java.util.Collections;
038import java.util.List;
039
040public class GetContentCollectionsCommand
041        extends BaseMultipleEntitiesCommand<ContentCollection, GetContentCollectionsForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ContentCollection.name(), SecurityRoles.List.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                ));
056    }
057    
058    /** Creates a new instance of GetContentCollectionsCommand */
059    public GetContentCollectionsCommand(UserVisitPK userVisitPK, GetContentCollectionsForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
061    }
062    
063    @Override
064    protected Collection<ContentCollection> getEntities() {
065        var contentControl = Session.getModelController(ContentControl.class);
066        
067        return contentControl.getContentCollections();
068    }
069    
070    @Override
071    protected BaseResult getResult(Collection<ContentCollection> entities) {
072        var contentControl = Session.getModelController(ContentControl.class);
073        GetContentCollectionsResult result = ContentResultFactory.getGetContentCollectionsResult();
074        
075        if(entities != null) {
076            result.setContentCollections(contentControl.getContentCollectionTransfers(getUserVisit(), entities));
077        }
078        
079        return result;
080    }
081    
082}