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.sequence.common;
018
019import com.echothree.control.user.sequence.common.form.*;
020import com.echothree.control.user.sequence.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 SequenceService
026        extends SequenceForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Sequence Types
036    // -------------------------------------------------------------------------
037    
038    CommandResult<CreateSequenceTypeResult> createSequenceType(UserVisitPK userVisitPK, CreateSequenceTypeForm form);
039    
040    CommandResult<GetSequenceTypesResult> getSequenceTypes(UserVisitPK userVisitPK, GetSequenceTypesForm form);
041    
042    CommandResult<GetSequenceTypeResult> getSequenceType(UserVisitPK userVisitPK, GetSequenceTypeForm form);
043    
044    CommandResult<GetSequenceTypeChoicesResult> getSequenceTypeChoices(UserVisitPK userVisitPK, GetSequenceTypeChoicesForm form);
045    
046    CommandResult<VoidResult> setDefaultSequenceType(UserVisitPK userVisitPK, SetDefaultSequenceTypeForm form);
047    
048    CommandResult<EditSequenceTypeResult> editSequenceType(UserVisitPK userVisitPK, EditSequenceTypeForm form);
049    
050    CommandResult<VoidResult> deleteSequenceType(UserVisitPK userVisitPK, DeleteSequenceTypeForm form);
051    
052    // -------------------------------------------------------------------------
053    //   Sequence Type Descriptions
054    // -------------------------------------------------------------------------
055    
056    CommandResult<VoidResult> createSequenceTypeDescription(UserVisitPK userVisitPK, CreateSequenceTypeDescriptionForm form);
057    
058    CommandResult<GetSequenceTypeDescriptionsResult> getSequenceTypeDescriptions(UserVisitPK userVisitPK, GetSequenceTypeDescriptionsForm form);
059    
060    CommandResult<EditSequenceTypeDescriptionResult> editSequenceTypeDescription(UserVisitPK userVisitPK, EditSequenceTypeDescriptionForm form);
061    
062    CommandResult<VoidResult> deleteSequenceTypeDescription(UserVisitPK userVisitPK, DeleteSequenceTypeDescriptionForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Sequence Checksum Types
066    // -------------------------------------------------------------------------
067    
068    CommandResult<VoidResult> createSequenceChecksumType(UserVisitPK userVisitPK, CreateSequenceChecksumTypeForm form);
069
070    CommandResult<GetSequenceChecksumTypesResult> getSequenceChecksumTypes(UserVisitPK userVisitPK, GetSequenceChecksumTypesForm form);
071
072    CommandResult<GetSequenceChecksumTypeResult> getSequenceChecksumType(UserVisitPK userVisitPK, GetSequenceChecksumTypeForm form);
073
074    CommandResult<GetSequenceChecksumTypeChoicesResult> getSequenceChecksumTypeChoices(UserVisitPK userVisitPK, GetSequenceChecksumTypeChoicesForm form);
075    
076    // -------------------------------------------------------------------------
077    //   Sequence Checksum Type Descriptions
078    // -------------------------------------------------------------------------
079    
080    CommandResult<VoidResult> createSequenceChecksumTypeDescription(UserVisitPK userVisitPK, CreateSequenceChecksumTypeDescriptionForm form);
081    
082    // -------------------------------------------------------------------------
083    //   Sequence Encoder Types
084    // -------------------------------------------------------------------------
085    
086    CommandResult<VoidResult> createSequenceEncoderType(UserVisitPK userVisitPK, CreateSequenceEncoderTypeForm form);
087
088    CommandResult<GetSequenceEncoderTypesResult> getSequenceEncoderTypes(UserVisitPK userVisitPK, GetSequenceEncoderTypesForm form);
089
090    CommandResult<GetSequenceEncoderTypeResult> getSequenceEncoderType(UserVisitPK userVisitPK, GetSequenceEncoderTypeForm form);
091    
092    CommandResult<GetSequenceEncoderTypeChoicesResult> getSequenceEncoderTypeChoices(UserVisitPK userVisitPK, GetSequenceEncoderTypeChoicesForm form);
093    
094    // -------------------------------------------------------------------------
095    //   Sequence Encoder Type Descriptions
096    // -------------------------------------------------------------------------
097    
098    CommandResult<VoidResult> createSequenceEncoderTypeDescription(UserVisitPK userVisitPK, CreateSequenceEncoderTypeDescriptionForm form);
099    
100    // -------------------------------------------------------------------------
101    //   Sequences
102    // -------------------------------------------------------------------------
103    
104    CommandResult<CreateSequenceResult> createSequence(UserVisitPK userVisitPK, CreateSequenceForm form);
105    
106    CommandResult<GetSequencesResult> getSequences(UserVisitPK userVisitPK, GetSequencesForm form);
107    
108    CommandResult<GetSequenceResult> getSequence(UserVisitPK userVisitPK, GetSequenceForm form);
109    
110    CommandResult<VoidResult> setDefaultSequence(UserVisitPK userVisitPK, SetDefaultSequenceForm form);
111    
112    CommandResult<GetSequenceChoicesResult> getSequenceChoices(UserVisitPK userVisitPK, GetSequenceChoicesForm form);
113    
114    CommandResult<EditSequenceResult> editSequence(UserVisitPK userVisitPK, EditSequenceForm form);
115    
116    CommandResult<VoidResult> deleteSequence(UserVisitPK userVisitPK, DeleteSequenceForm form);
117    
118    // -------------------------------------------------------------------------
119    //   Sequence Descriptions
120    // -------------------------------------------------------------------------
121    
122    CommandResult<VoidResult> createSequenceDescription(UserVisitPK userVisitPK, CreateSequenceDescriptionForm form);
123    
124    CommandResult<GetSequenceDescriptionsResult> getSequenceDescriptions(UserVisitPK userVisitPK, GetSequenceDescriptionsForm form);
125    
126    CommandResult<EditSequenceDescriptionResult> editSequenceDescription(UserVisitPK userVisitPK, EditSequenceDescriptionForm form);
127    
128    CommandResult<VoidResult> deleteSequenceDescription(UserVisitPK userVisitPK, DeleteSequenceDescriptionForm form);
129    
130    // -------------------------------------------------------------------------
131    //    Sequence Values
132    // -------------------------------------------------------------------------
133    
134    CommandResult<VoidResult> setSequenceValue(UserVisitPK userVisitPK, SetSequenceValueForm form);
135
136    CommandResult<GetSequenceValueResult> getSequenceValue(UserVisitPK userVisitPK, GetSequenceValueForm form);
137
138    CommandResult<GetNextSequenceValueResult> getNextSequenceValue(UserVisitPK userVisitPK, GetNextSequenceValueForm form);
139
140}