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