Package edu.suffolk.litlab.efsp.ecfcodes

Interface CodesParser

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TylerCodesParser

public interface CodesParser
extends AutoCloseable

Given the strings from an input case, 'parses' them (i.e. checks, confirms, and converts them into slightly more strict types).

TODO(brycew): still needs to remove the tyler specific codes from this API

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CodesParser.AttorneyError
static final record	CodesParser.BadCode
static interface	CodesParser.CodeError
static interface	CodesParser.CrossReferenceError
static final record	CodesParser.CumulativeDocsTooBig
static final record	CodesParser.DocTooBig
static final record	CodesParser.DueDateRequired
static final record	CodesParser.FileExtensionNotAllowed
static interface	CodesParser.FileNameError
static final record	CodesParser.FileNameTextError
static interface	CodesParser.FilingDocError
static final record	CodesParser.InputOptionalService
static final record	CodesParser.InvalidFilingAction
static final record	CodesParser.MissingRequiredRefs
static final record	CodesParser.MissingVar
static final record	CodesParser.NoMatchingCode
static final record	CodesParser.NoMatchingRef
static final record	CodesParser.NoMultipleAttorneys
static final record	CodesParser.RequiredAttorneys
static final record	CodesParser.RequiredCodeNotPresent
static interface	CodesParser.TextVarError
static final record	CodesParser.ThingRequired
static final record	CodesParser.TooLongVar
static final record	CodesParser.WrongRefVal
static final record	CodesParser.WrongVar

Method Summary

Modifier and Type	Method	Description
com.hubspot.algebra.Result<Map<String,String>,CodesParser.CrossReferenceError>	getCrossRefIds(Map<String,String> crossRefs, CaseType caseType)
Optional<String>	getDocumentDescription(String description, String firstFileName, FilingCode filing)
List<FilingComponent>	retrieveFilingComponents(FilingCode filingCode)
com.hubspot.algebra.Result<List<FilingCode>,CodesParser.BadCode>	retrieveFilingOptions(CaseCategory caseCategory, CaseType type, boolean isInitialFiling)
boolean	useFilingAssociations()
com.hubspot.algebra.Result<Optional<BigDecimal>,CodesParser.ThingRequired>	vetAmountInControversy(Optional<BigDecimal> amt, List<FilingCode> filings)
com.hubspot.algebra.Result<CaseCategory,CodesParser.CodeError>	vetCaseCat(String caseCategoryCode)
com.hubspot.algebra.Result<CaseType,CodesParser.CodeError>	vetCaseType(String caseTypeCode, CaseCategory caseCategory, boolean isInitialFiling)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetComment(Optional<String> comment)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetDamageAmount(boolean initial, CaseCategory cat, Optional<String> maybeDamageAmount)
com.hubspot.algebra.Result<Optional<DocumentTypeTableRow>,CodesParser.CodeError>	vetDocType(String docTypeStr, FilingCode filing)
com.hubspot.algebra.Result<Optional<LocalDate>,CodesParser.DueDateRequired>	vetDueDate(Optional<LocalDate> dueDate, FilingCode filing)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetEmail(Optional<String> email)
com.hubspot.algebra.Result<String,CodesParser.FileNameError>	vetFileName(String fileName)
com.hubspot.algebra.Result<Optional<FilerType>,CodesParser.CodeError>	vetFilerType(Optional<String> maybeFilerType)
com.hubspot.algebra.Result<Optional<FilingAction>,CodesParser.InvalidFilingAction>	vetFilingAction(Optional<FilingAction> filingAction, boolean isInitialFiling, boolean hasServiceContacts)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetFilingAttorney(Optional<String> filingAttorney)
com.hubspot.algebra.Result<FilingComponent,CodesParser.CodeError>	vetFilingComponent(String filingComponent, ArrayList<FilingComponent> components)
com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,CodesParser.FilingDocError>	vetFilingDocSize(List<FilingDoc> docs)
com.hubspot.algebra.Result<List<PartyId>,CodesParser.ThingRequired>	vetFilingParties(List<PartyId> filingParties)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetFilingRefNum(Optional<String> fileRefNum)
com.hubspot.algebra.Result<FilingCode,CodesParser.CodeError>	vetFilingType(Optional<String> filingCode, List<FilingCode> filingOptions)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetFirstName(Optional<String> name)
com.hubspot.algebra.Result<Optional<Person.Gender>,CodesParser.TextVarError>	vetGender(Optional<String> gender)
com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError>	vetLangCode(Optional<String> lang)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetLastName(Optional<String> name)
Optional<BigDecimal>	vetMaxAmount(Optional<BigDecimal> maxAmount)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetMiddleName(Optional<String> name)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetMotionCode(Optional<String> motionCode, FilingCode filing)
com.hubspot.algebra.Result<List<OptionalService>,List<CodesParser.CodeError>>	vetOptionalServices(List<CodesParser.InputOptionalService> servs, FilingCode filing)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetOrgName(String name)
com.hubspot.algebra.Result<Optional<Map<PartyId,List<String>>>,CodesParser.AttorneyError>	vetPartyAttorneyMap(Map<PartyId,List<String>> partyAttyMap, Collection<PartyId> partyIdSet, Collection<String> attySet)
com.hubspot.algebra.Result<Map<PartyId,PartyInfo>,CodesParser.CodeError>	vetPartyTypes(Collection<Person> existingParties, Collection<Person> newParties, CaseType type, boolean isFirstIndexedFiling)
com.hubspot.algebra.Result<List<String>,CodesParser.TextVarError>	vetPhoneNumbers(List<String> numbers)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetProcedureRemedy(Optional<String> maybeProRem, boolean initial, CaseCategory cat)
com.hubspot.algebra.Result<String,CodesParser.CodeError>	vetStateCode(String state, String countryString)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.NoMatchingCode>	vetSubType(String subtypeCode, CaseType caseType)
com.hubspot.algebra.Result<String,CodesParser.CodeError>	vetSuffix(Optional<String> suffix)

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

vetCaseCat

com.hubspot.algebra.Result<CaseCategory,CodesParser.CodeError> vetCaseCat(String caseCategoryCode)

vetCaseType

com.hubspot.algebra.Result<CaseType,CodesParser.CodeError> vetCaseType(String caseTypeCode,
 CaseCategory caseCategory,
 boolean isInitialFiling)

vetSubType

com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.NoMatchingCode> vetSubType(String subtypeCode,
 CaseType caseType)

retrieveFilingOptions

com.hubspot.algebra.Result<List<FilingCode>,CodesParser.BadCode> retrieveFilingOptions(CaseCategory caseCategory,
 CaseType type,
 boolean isInitialFiling)

vetFilingType

com.hubspot.algebra.Result<FilingCode,CodesParser.CodeError> vetFilingType(Optional<String> filingCode,
 List<FilingCode> filingOptions)

vetSuffix

com.hubspot.algebra.Result<String,CodesParser.CodeError> vetSuffix(Optional<String> suffix)

vetLangCode

com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError> vetLangCode(Optional<String> lang)

vetStateCode

com.hubspot.algebra.Result<String,CodesParser.CodeError> vetStateCode(String state,
 String countryString)

getCrossRefIds

com.hubspot.algebra.Result<Map<String,String>,CodesParser.CrossReferenceError> getCrossRefIds(Map<String,String> crossRefs,
 CaseType caseType)

vetPartyTypes

com.hubspot.algebra.Result<Map<PartyId,PartyInfo>,CodesParser.CodeError> vetPartyTypes(Collection<Person> existingParties,
 Collection<Person> newParties,
 CaseType type,
 boolean isFirstIndexedFiling)

vetFilingParties

com.hubspot.algebra.Result<List<PartyId>,CodesParser.ThingRequired> vetFilingParties(List<PartyId> filingParties)

vetMotionCode

com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetMotionCode(Optional<String> motionCode,
 FilingCode filing)

vetOptionalServices

com.hubspot.algebra.Result<List<OptionalService>,List<CodesParser.CodeError>> vetOptionalServices(List<CodesParser.InputOptionalService> servs,
 FilingCode filing)

retrieveFilingComponents

List<FilingComponent> retrieveFilingComponents(FilingCode filingCode)

vetFilingComponent

com.hubspot.algebra.Result<FilingComponent,CodesParser.CodeError> vetFilingComponent(String filingComponent,
 ArrayList<FilingComponent> components)

vetFilerType

com.hubspot.algebra.Result<Optional<FilerType>,CodesParser.CodeError> vetFilerType(Optional<String> maybeFilerType)

vetDocType

com.hubspot.algebra.Result<Optional<DocumentTypeTableRow>,CodesParser.CodeError> vetDocType(String docTypeStr,
 FilingCode filing)

vetDamageAmount

com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetDamageAmount(boolean initial,
 CaseCategory cat,
 Optional<String> maybeDamageAmount)

vetProcedureRemedy

com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetProcedureRemedy(Optional<String> maybeProRem,
 boolean initial,
 CaseCategory cat)

vetPartyAttorneyMap

com.hubspot.algebra.Result<Optional<Map<PartyId,List<String>>>,CodesParser.AttorneyError> vetPartyAttorneyMap(Map<PartyId,List<String>> partyAttyMap,
 Collection<PartyId> partyIdSet,
 Collection<String> attySet)

vetFilingAttorney

com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetFilingAttorney(Optional<String> filingAttorney)

vetEmail

com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetEmail(Optional<String> email)

vetPhoneNumbers

com.hubspot.algebra.Result<List<String>,CodesParser.TextVarError> vetPhoneNumbers(List<String> numbers)

vetFirstName

com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetFirstName(Optional<String> name)

vetMiddleName

com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetMiddleName(Optional<String> name)

vetLastName

com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetLastName(Optional<String> name)

vetOrgName

com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetOrgName(String name)

vetGender

com.hubspot.algebra.Result<Optional<Person.Gender>,CodesParser.TextVarError> vetGender(Optional<String> gender)

vetFilingRefNum

com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetFilingRefNum(Optional<String> fileRefNum)

vetComment

com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetComment(Optional<String> comment)

vetDueDate

com.hubspot.algebra.Result<Optional<LocalDate>,CodesParser.DueDateRequired> vetDueDate(Optional<LocalDate> dueDate,
 FilingCode filing)

vetFilingAction

com.hubspot.algebra.Result<Optional<FilingAction>,CodesParser.InvalidFilingAction> vetFilingAction(Optional<FilingAction> filingAction,
 boolean isInitialFiling,
 boolean hasServiceContacts)

getDocumentDescription

Optional<String> getDocumentDescription(String description,
 String firstFileName,
 FilingCode filing)

vetFileName

com.hubspot.algebra.Result<String,CodesParser.FileNameError> vetFileName(String fileName)

vetFilingDocSize

com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,CodesParser.FilingDocError> vetFilingDocSize(List<FilingDoc> docs)

vetAmountInControversy

com.hubspot.algebra.Result<Optional<BigDecimal>,CodesParser.ThingRequired> vetAmountInControversy(Optional<BigDecimal> amt,
 List<FilingCode> filings)

vetMaxAmount

Optional<BigDecimal> vetMaxAmount(Optional<BigDecimal> maxAmount)

useFilingAssociations

boolean useFilingAssociations()