Package edu.suffolk.litlab.efsp.server.services.api

Interface EfmFilingInterface

All Known Implementing Classes:

Ecf4Filer, EfmCheckableFilingInterface

public interface EfmFilingInterface

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EfmFilingInterface.ApiChoice

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	cancelFiling(String courtId, String filingId, TylerUserNamePassword creds)
com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,FilingError>	checkFiling(FilingInformation info, TylerUserNamePassword creds, String userUuid, InfoCollector collector)
jakarta.ws.rs.core.Response	disclaimers(String courtId)	TYLER ONLY at the moment: returns a list of disclaimers that must be shown to the user before filing.
jakarta.ws.rs.core.Response	getFilingDetails(String courtId, String filingId, TylerUserNamePassword creds)
com.hubspot.algebra.Result<jakarta.ws.rs.core.Response,FilingError>	getFilingFees(FilingInformation info, TylerUserNamePassword creds)
jakarta.ws.rs.core.Response	getFilingList(String courtId, String submitterId, LocalDate startDate, LocalDate beforeDate, TylerUserNamePassword creds)
jakarta.ws.rs.core.Response	getFilingService(String courtId, String filingId, String contactId, TylerUserNamePassword creds)
jakarta.ws.rs.core.Response	getFilingStatus(String courtId, String filingId, TylerUserNamePassword creds)
String	getHeaderKey()	Used to get the proper header that contains the right token.
String	getOrgName()	Used to properly verify with the SecurityHub.
Optional<CodesParser>	getParser(String courtId, TylerUserNamePassword creds)
jakarta.ws.rs.core.Response	getPolicy(String courtId, TylerUserNamePassword creds)
com.hubspot.algebra.Result<jakarta.ws.rs.core.Response,FilingError>	getServiceTypes(FilingInformation info, TylerUserNamePassword creds)
com.hubspot.algebra.Result<FilingResult,FilingError>	sendFiling(FilingInformation info, TylerUserNamePassword creds, String userUuid, EfmFilingInterface.ApiChoice choice)	Actually sends the filing information to the EFM if it can.

Method Details

sendFiling

com.hubspot.algebra.Result<FilingResult,FilingError> sendFiling(FilingInformation info,
 TylerUserNamePassword creds,
 String userUuid,
 EfmFilingInterface.ApiChoice choice)

Actually sends the filing information to the EFM if it can.

Parameters:

info - All of the information, parsed from an InterviewToFilingInformationConverter

Returns:

Either a list of UUIDs for each filing actually made to the EFM, or an error if it couldn't make the filing. The list is because a single filing can include child envelopes or child filings, or just need to be split up into multiple filings. We shouldn't care about how that split happens, we just need to know the UUIDs for each of the filings for the callbacks. If it's > 1, should be the same number as the FilingDocs in info

checkFiling

com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,FilingError> checkFiling(FilingInformation info,
 TylerUserNamePassword creds,
 String userUuid,
 InfoCollector collector)

getFilingFees

com.hubspot.algebra.Result<jakarta.ws.rs.core.Response,FilingError> getFilingFees(FilingInformation info,
 TylerUserNamePassword creds)

getServiceTypes

com.hubspot.algebra.Result<jakarta.ws.rs.core.Response,FilingError> getServiceTypes(FilingInformation info,
 TylerUserNamePassword creds)

getFilingList

jakarta.ws.rs.core.Response getFilingList(String courtId,
 String submitterId,
 LocalDate startDate,
 LocalDate beforeDate,
 TylerUserNamePassword creds)

getFilingStatus

jakarta.ws.rs.core.Response getFilingStatus(String courtId,
 String filingId,
 TylerUserNamePassword creds)

getFilingDetails

jakarta.ws.rs.core.Response getFilingDetails(String courtId,
 String filingId,
 TylerUserNamePassword creds)

getFilingService

jakarta.ws.rs.core.Response getFilingService(String courtId,
 String filingId,
 String contactId,
 TylerUserNamePassword creds)

getPolicy

jakarta.ws.rs.core.Response getPolicy(String courtId,
 TylerUserNamePassword creds)

cancelFiling

jakarta.ws.rs.core.Response cancelFiling(String courtId,
 String filingId,
 TylerUserNamePassword creds)

getParser

Optional<CodesParser> getParser(String courtId,
 TylerUserNamePassword creds)

disclaimers

jakarta.ws.rs.core.Response disclaimers(String courtId)

TYLER ONLY at the moment: returns a list of disclaimers that must be shown to the user before filing.

Parameters:

courtId - The court location Id where the filing is taking place

Returns:

A response, that has a JSON list of the disclaimer information (code, name, listorder, text)

getOrgName

String getOrgName()

Used to properly verify with the SecurityHub.

getHeaderKey

String getHeaderKey()

Used to get the proper header that contains the right token.