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.common;
018
019import com.echothree.control.user.period.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface PeriodService
024        extends PeriodForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Period Kinds
034    // -------------------------------------------------------------------------
035    
036    CommandResult createPeriodKind(UserVisitPK userVisitPK, CreatePeriodKindForm form);
037    
038    CommandResult getPeriodKinds(UserVisitPK userVisitPK, GetPeriodKindsForm form);
039    
040    CommandResult getPeriodKind(UserVisitPK userVisitPK, GetPeriodKindForm form);
041    
042    CommandResult getPeriodKindChoices(UserVisitPK userVisitPK, GetPeriodKindChoicesForm form);
043    
044    CommandResult setDefaultPeriodKind(UserVisitPK userVisitPK, SetDefaultPeriodKindForm form);
045    
046    CommandResult editPeriodKind(UserVisitPK userVisitPK, EditPeriodKindForm form);
047    
048    CommandResult deletePeriodKind(UserVisitPK userVisitPK, DeletePeriodKindForm form);
049    
050    // -------------------------------------------------------------------------
051    //   Period Kind Descriptions
052    // -------------------------------------------------------------------------
053    
054    CommandResult createPeriodKindDescription(UserVisitPK userVisitPK, CreatePeriodKindDescriptionForm form);
055    
056    CommandResult getPeriodKindDescriptions(UserVisitPK userVisitPK, GetPeriodKindDescriptionsForm form);
057    
058    CommandResult editPeriodKindDescription(UserVisitPK userVisitPK, EditPeriodKindDescriptionForm form);
059    
060    CommandResult deletePeriodKindDescription(UserVisitPK userVisitPK, DeletePeriodKindDescriptionForm form);
061    
062    // -------------------------------------------------------------------------
063    //   Period Types
064    // -------------------------------------------------------------------------
065    
066    CommandResult createPeriodType(UserVisitPK userVisitPK, CreatePeriodTypeForm form);
067    
068    CommandResult getPeriodTypes(UserVisitPK userVisitPK, GetPeriodTypesForm form);
069    
070    CommandResult getPeriodType(UserVisitPK userVisitPK, GetPeriodTypeForm form);
071    
072    CommandResult getPeriodTypeChoices(UserVisitPK userVisitPK, GetPeriodTypeChoicesForm form);
073    
074    CommandResult setDefaultPeriodType(UserVisitPK userVisitPK, SetDefaultPeriodTypeForm form);
075    
076    CommandResult editPeriodType(UserVisitPK userVisitPK, EditPeriodTypeForm form);
077    
078    CommandResult deletePeriodType(UserVisitPK userVisitPK, DeletePeriodTypeForm form);
079    
080    // -------------------------------------------------------------------------
081    //   Period Type Descriptions
082    // -------------------------------------------------------------------------
083    
084    CommandResult createPeriodTypeDescription(UserVisitPK userVisitPK, CreatePeriodTypeDescriptionForm form);
085    
086    CommandResult getPeriodTypeDescriptions(UserVisitPK userVisitPK, GetPeriodTypeDescriptionsForm form);
087    
088    CommandResult editPeriodTypeDescription(UserVisitPK userVisitPK, EditPeriodTypeDescriptionForm form);
089    
090    CommandResult deletePeriodTypeDescription(UserVisitPK userVisitPK, DeletePeriodTypeDescriptionForm form);
091    
092    // -------------------------------------------------------------------------
093    //   Fiscal Periods
094    // -------------------------------------------------------------------------
095    
096    CommandResult createFiscalYear(UserVisitPK userVisitPK, CreateFiscalYearForm form);
097    
098    CommandResult getFiscalPeriodStatusChoices(UserVisitPK userVisitPK, GetFiscalPeriodStatusChoicesForm form);
099    
100    CommandResult setFiscalPeriodStatus(UserVisitPK userVisitPK, SetFiscalPeriodStatusForm form);
101    
102}