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