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.period.server.command;
018
019import com.echothree.control.user.period.common.form.GetPeriodKindDescriptionsForm;
020import com.echothree.control.user.period.common.result.GetPeriodKindDescriptionsResult;
021import com.echothree.control.user.period.common.result.PeriodResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.period.server.control.PeriodControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.period.server.entity.PeriodKind;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetPeriodKindDescriptionsCommand
042        extends BaseSimpleCommand<GetPeriodKindDescriptionsForm> {
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.PeriodKind.name(), SecurityRoles.Description.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056            new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null)
057        ));
058    }
059    
060    /** Creates a new instance of GetPeriodKindDescriptionsCommand */
061    public GetPeriodKindDescriptionsCommand(UserVisitPK userVisitPK, GetPeriodKindDescriptionsForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var periodControl = Session.getModelController(PeriodControl.class);
068        GetPeriodKindDescriptionsResult result = PeriodResultFactory.getGetPeriodKindDescriptionsResult();
069        String periodKindName = form.getPeriodKindName();
070        PeriodKind periodKind = periodControl.getPeriodKindByName(periodKindName);
071        
072        if(periodKind != null) {
073            result.setPeriodKind(periodControl.getPeriodKindTransfer(getUserVisit(), periodKind));
074            result.setPeriodKindDescriptions(periodControl.getPeriodKindDescriptionTransfersByPeriodKind(getUserVisit(), periodKind));
075        } else {
076            addExecutionError(ExecutionErrors.UnknownPeriodKindName.name(), periodKindName);
077        }
078        
079        return result;
080    }
081    
082}