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

Class EcfCodesService

java.lang.Object
edu.suffolk.litlab.efsp.server.services.CodesService
edu.suffolk.litlab.efsp.server.services.EcfCodesService
public class EcfCodesService extends CodesService

  • Constructor Details

  • Method Details

    • getAll

      public jakarta.ws.rs.core.Response getAll()
      Specified by:
      getAll in class CodesService

    • getCourts

      public jakarta.ws.rs.core.Response getCourts(jakarta.ws.rs.core.HttpHeaders httpHeaders, boolean fileableOnly, boolean withNames)
      Specified by:
      getCourts in class CodesService

    • getCodesUnderCourt

      public jakarta.ws.rs.core.Response getCodesUnderCourt(String courtId)
      Specified by:
      getCodesUnderCourt in class CodesService

    • getCourtLocationCodes

      public jakarta.ws.rs.core.Response getCourtLocationCodes(String courtId)
      Specified by:
      getCourtLocationCodes in class CodesService

    • getCodesUnderCaseType

      @GET @Path("/courts/{court_id}/case_types/{case_type_id}") public jakarta.ws.rs.core.Response getCodesUnderCaseType(@PathParam("court_id") String courtId, @PathParam("case_type_id") String caseTypeId) throws SQLException
      Returns detailed into on a specific case type, as well as being a HATEOS endpoint (i.e. points to other endpoints).
      Throws:
      SQLException

    • getCodesUnderFilingTypes

      @GET @Path("/courts/{court_id}/filing_types/{filing_code_id}") public jakarta.ws.rs.core.Response getCodesUnderFilingTypes(@PathParam("court_id") String courtId, @PathParam("filing_code_id") String filingCode) throws SQLException
      Throws:
      SQLException

    • searchCategories

      @GET @Path("/categories") public jakarta.ws.rs.core.Response searchCategories(@QueryParam("search") String searchTerm, @QueryParam("result") String resultStr) throws SQLException
      Finds categories in any court that match the given term.

      If the "result" query parameter is set to "COURT_COVERAGE", instead returns all courts that contain at least one case category that is matched by the term. Can be used to confirm that all of the expected courts you want to file in contain a case category that you can use.

      Used primarly for exploration and gaining a better understanding of jurisdiction naming conventions. Likely shouldn't be used while a user is filing.

      Throws:
      SQLException

    • retrieveCategories

      @GET @Path("/categories/{retrieve_name}") public jakarta.ws.rs.core.Response retrieveCategories(@PathParam("retrieve_name") String retrieveName) throws SQLException
      Throws:
      SQLException

    • searchCaseTypes

      @GET @Path("/case_types") public jakarta.ws.rs.core.Response searchCaseTypes(@QueryParam("search") String searchTerm, @QueryParam("result") String resultStr) throws SQLException
      Finds case types in any court that match the given term.

      If the "result" query parameter is set to "COURT_COVERAGE", instead returns all courts that contain at least one case type that is matched by the term. Can be used to confirm that all of the expected courts you want to file in contain a case type that you can use.

      Used primarly for exploration and gaining a better understanding of jurisdiction naming conventions. Likely shouldn't be used while a user is filing.

      Throws:
      SQLException

    • retrieveCaseTypes

      @GET @Path("/case_types/{retrieve_name}") public jakarta.ws.rs.core.Response retrieveCaseTypes(@PathParam("retrieve_name") String retrieveName) throws SQLException
      Throws:
      SQLException

    • searchFilingTypes

      @GET @Path("/filing_types") public jakarta.ws.rs.core.Response searchFilingTypes(@QueryParam("search") String searchTerm, @QueryParam("result") String resultStr) throws SQLException
      Finds filings types in any court that match the given term.

      If the "result" query parameter is set to "COURT_COVERAGE", instead returns all courts that contain at least one filing type that is matched by the term. Can be used to confirm that all of the expected courts you want to file in contain a filing type that you can use.

      Used primarly for exploration and gaining a better understanding of jurisdiction naming conventions. Likely shouldn't be used while a user is filing.

      Throws:
      SQLException

    • retrieveFilingTypes

      @GET @Path("/filing_types/{retrieve_name}") public jakarta.ws.rs.core.Response retrieveFilingTypes(@PathParam("retrieve_name") String retrieveName) throws SQLException
      Throws:
      SQLException

    • searchPartyTypes

      @GET @Path("/party_types") public jakarta.ws.rs.core.Response searchPartyTypes(@QueryParam("search") String searchTerm, @QueryParam("result") String resultStr) throws SQLException
      Finds party types in any court that match the given term.

      If the "result" query parameter is set to "COURT_COVERAGE", instead returns all courts that contain at least one party type that is matched by the term. Can be used to confirm that all of the expected courts you want to file in contain a party type that you can use.

      NOTE: party types are usually tightly coupled to the type of case they are in, so a general search like this might not be as useful.

      Used primarly for exploration and gaining a better understanding of jurisdiction naming conventions. Likely shouldn't be used while a user is filing.

      Throws:
      SQLException

    • retrievePartyTypes

      @GET @Path("/party_types/{retrieve_name}") public jakarta.ws.rs.core.Response retrievePartyTypes(@PathParam("retrieve_name") String retrieveName) throws SQLException
      Throws:
      SQLException

    • searchOptionalServices

      @GET @Path("/optional_services") public jakarta.ws.rs.core.Response searchOptionalServices(@QueryParam("search") String searchTerm, @QueryParam("result") String resultStr) throws SQLException
      Finds optional services in any court that match the given term.

      If the "result" query parameter is set to "COURT_COVERAGE", instead returns all courts that contain at least one optional service that is matched by the term. Can be used to confirm that all of the expected courts you want to file in contain an optional service that you can use.

      Used primarly for exploration and gaining a better understanding of jurisdiction naming conventions. Likely shouldn't be used while a user is filing.

      Throws:
      SQLException

    • retrieveOptionalServices

      @GET @Path("/optional_services/{retrieve_name}") public jakarta.ws.rs.core.Response retrieveOptionalServices(@PathParam("retrieve_name") String retrieveName) throws SQLException
      Throws:
      SQLException

    • getCategories

      public jakarta.ws.rs.core.Response getCategories(String courtId, boolean fileableOnly, String timing) throws SQLException
      Specified by:
      getCategories in class CodesService
      Throws:
      SQLException

    • getCategoryByCode

      public jakarta.ws.rs.core.Response getCategoryByCode(String courtId, String catCode) throws SQLException
      Specified by:
      getCategoryByCode in class CodesService
      Throws:
      SQLException

    • getCaseTypes

      public jakarta.ws.rs.core.Response getCaseTypes(String courtId, String categoryId, String timing) throws SQLException
      Specified by:
      getCaseTypes in class CodesService
      Throws:
      SQLException

    • getNameSuffixes

      public jakarta.ws.rs.core.Response getNameSuffixes(String courtId) throws SQLException
      Specified by:
      getNameSuffixes in class CodesService
      Throws:
      SQLException

    • getCaseSubtypes

      public jakarta.ws.rs.core.Response getCaseSubtypes(String courtId, String caseTypeId) throws SQLException
      Specified by:
      getCaseSubtypes in class CodesService
      Throws:
      SQLException

    • getServiceTypes

      public jakarta.ws.rs.core.Response getServiceTypes(String courtId) throws SQLException
      Specified by:
      getServiceTypes in class CodesService
      Throws:
      SQLException

    • getProcedureOrRemedies

      public jakarta.ws.rs.core.Response getProcedureOrRemedies(String courtId, String categoryId) throws SQLException
      Specified by:
      getProcedureOrRemedies in class CodesService
      Throws:
      SQLException

    • getFilingTypes

      public jakarta.ws.rs.core.Response getFilingTypes(String courtId, String categoryId, String typeId, boolean initial) throws SQLException
      Specified by:
      getFilingTypes in class CodesService
      Parameters:
      courtId - The court id where these filing types are present.
      categoryId - (optional) used to filter by filing types that can only be used with this case category.
      typeId - (optional) used to filter by filing types that can only be used with this case type
      initial - if true, shows filing types that can be used on initial filings (or initial and subsequent filings). If false, shows filings that can be used on subsequent filings.
      Returns:
      The filing info
      Throws:
      SQLException

    • getFilerTypes

      public jakarta.ws.rs.core.Response getFilerTypes(String courtId) throws SQLException
      Specified by:
      getFilerTypes in class CodesService
      Throws:
      SQLException

    • getDamageAmounts

      public jakarta.ws.rs.core.Response getDamageAmounts(String courtId, String categoryId) throws SQLException
      Specified by:
      getDamageAmounts in class CodesService
      Throws:
      SQLException

    • getAllPartyTypes

      public jakarta.ws.rs.core.Response getAllPartyTypes(String courtId) throws SQLException
      Description copied from class: CodesService
      Used for when you need to populate the party types names for a case search or something similar
      Specified by:
      getAllPartyTypes in class CodesService
      Parameters:
      courtId -
      Returns:
      Throws:
      SQLException

    • getPartyTypeFromAll

      public jakarta.ws.rs.core.Response getPartyTypeFromAll(String courtId, String partyTypeId) throws SQLException
      Specified by:
      getPartyTypeFromAll in class CodesService
      Throws:
      SQLException

    • getPartyTypes

      public jakarta.ws.rs.core.Response getPartyTypes(String courtId, String caseTypeId) throws SQLException
      Specified by:
      getPartyTypes in class CodesService
      Throws:
      SQLException

    • getPartyType

      public jakarta.ws.rs.core.Response getPartyType(String courtId, String caseTypeId, String partyTypeId) throws SQLException
      Specified by:
      getPartyType in class CodesService
      Throws:
      SQLException

    • getCrossReferencesOld

      @Deprecated public jakarta.ws.rs.core.Response getCrossReferencesOld(String courtId, String caseTypeId) throws SQLException
      Deprecated.
      Specified by:
      getCrossReferencesOld in class CodesService
      Throws:
      SQLException

    • getCrossReferences

      public jakarta.ws.rs.core.Response getCrossReferences(String courtId, String caseTypeId) throws SQLException
      Specified by:
      getCrossReferences in class CodesService
      Throws:
      SQLException

    • getDocumentTypes

      public jakarta.ws.rs.core.Response getDocumentTypes(String courtId, String filingCodeId) throws SQLException
      Specified by:
      getDocumentTypes in class CodesService
      Throws:
      SQLException

    • getMotionTypes

      public jakarta.ws.rs.core.Response getMotionTypes(String courtId, String filingCodeId) throws SQLException
      Specified by:
      getMotionTypes in class CodesService
      Throws:
      SQLException

    • getAllowedFileTypes

      public jakarta.ws.rs.core.Response getAllowedFileTypes(String courtId) throws SQLException
      Specified by:
      getAllowedFileTypes in class CodesService
      Throws:
      SQLException

    • getFilingStatuses

      public jakarta.ws.rs.core.Response getFilingStatuses(String courtId) throws SQLException
      Specified by:
      getFilingStatuses in class CodesService
      Throws:
      SQLException

    • getFilingComponents

      public jakarta.ws.rs.core.Response getFilingComponents(String courtId, String filingCodeId) throws SQLException
      Specified by:
      getFilingComponents in class CodesService
      Throws:
      SQLException

    • getOptionalServices

      public jakarta.ws.rs.core.Response getOptionalServices(String courtId, String filingCodeId) throws SQLException
      Specified by:
      getOptionalServices in class CodesService
      Throws:
      SQLException

    • getStates

      public jakarta.ws.rs.core.Response getStates(String courtId, String country) throws SQLException
      Specified by:
      getStates in class CodesService
      Throws:
      SQLException

    • getLanguages

      public jakarta.ws.rs.core.Response getLanguages(String courtId) throws SQLException
      Specified by:
      getLanguages in class CodesService
      Throws:
      SQLException

    • getDataFields

      public jakarta.ws.rs.core.Response getDataFields(String courtId) throws SQLException
      Specified by:
      getDataFields in class CodesService
      Throws:
      SQLException

    • getDataField

      public jakarta.ws.rs.core.Response getDataField(String courtId, String fieldName) throws SQLException
      Specified by:
      getDataField in class CodesService
      Throws:
      SQLException

    • getOptionalService

      public jakarta.ws.rs.core.Response getOptionalService(String courtId, String optServCode) throws SQLException
      Specified by:
      getOptionalService in class CodesService
      Throws:
      SQLException

    • getDisclaimerRequirements

      public jakarta.ws.rs.core.Response getDisclaimerRequirements(String courtId) throws SQLException
      Specified by:
      getDisclaimerRequirements in class CodesService
      Throws:
      SQLException