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.offer.server.command;
018
019import com.echothree.control.user.offer.common.form.GetUsesForm;
020import com.echothree.control.user.offer.common.result.GetUsesResult;
021import com.echothree.control.user.offer.common.result.OfferResultFactory;
022import com.echothree.model.control.offer.server.control.UseControl;
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.offer.server.entity.Use;
027import com.echothree.model.data.offer.server.factory.UseFactory;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collection;
038import java.util.Collections;
039import java.util.List;
040
041public class GetUsesCommand
042        extends BaseMultipleEntitiesCommand<Use, GetUsesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Use.name(), SecurityRoles.List.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                ));
057    }
058    
059    /** Creates a new instance of GetUsesCommand */
060    public GetUsesCommand(UserVisitPK userVisitPK, GetUsesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063    
064    @Override
065    protected Collection<Use> getEntities() {
066        var useControl = Session.getModelController(UseControl.class);
067        
068        return useControl.getUses();
069    }
070    
071    @Override
072    protected BaseResult getResult(Collection<Use> entities) {
073        GetUsesResult result = OfferResultFactory.getGetUsesResult();
074        var useControl = Session.getModelController(UseControl.class);
075        
076        if(session.hasLimit(UseFactory.class)) {
077            result.setUseCount(useControl.countUses());
078        }
079
080        result.setUses(useControl.getUseTransfers(getUserVisit(), entities));
081        
082        return result;
083    }
084    
085}