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.subscription.server.command;
018
019import com.echothree.control.user.subscription.common.form.GetSubscriptionKindsForm;
020import com.echothree.control.user.subscription.common.result.GetSubscriptionKindsResult;
021import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.subscription.server.control.SubscriptionControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class GetSubscriptionKindsCommand
039        extends BaseSimpleCommand<GetSubscriptionKindsForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                    new SecurityRoleDefinition(SecurityRoleGroups.SubscriptionKind.name(), SecurityRoles.List.name())
049                    )))
050                )));
051
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                ));
054    }
055
056    /** Creates a new instance of GetSubscriptionKindsCommand */
057    public GetSubscriptionKindsCommand(UserVisitPK userVisitPK, GetSubscriptionKindsForm form) {
058        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
064        GetSubscriptionKindsResult result = SubscriptionResultFactory.getGetSubscriptionKindsResult();
065        
066        result.setSubscriptionKinds(subscriptionControl.getSubscriptionKindTransfers(getUserVisit()));
067        
068        return result;
069    }
070    
071}