Package com.sudicode.fb2gh.fogbugz

Interface FogBugz

  • public interface FogBugz
    Entry point for the FogBugz API. Use FBFactory to instantiate.

    • Method Detail

      • listMilestones

        List<FBMilestone> listMilestones​(FBProject project)
                          throws FB2GHException
        Get a list of all milestones from this FogBugz instance.
        Parameters:
        project - Only list milestones for this project.
        Returns:
        The list
        Throws:
        FB2GHException - if there is an API issue.

      • listAreas

        List<FBArea> listAreas​(FBProject project)
                throws FB2GHException
        Get a list of all areas from this FogBugz instance.
        Parameters:
        project - Only list areas for this project.
        Returns:
        The list
        Throws:
        FB2GHException - if there is an API issue.

      • listStatuses

        List<FBStatus> listStatuses​(FBCategory category)
                     throws FB2GHException
        Get a list of all statuses from this FogBugz instance.
        Parameters:
        category - Only list statues from this category.
        Returns:
        The list
        Throws:
        FB2GHException - if there is an API issue.

      • getCase

        FBCase getCase​(int caseId)
        throws FB2GHException
        Get a single case.
        Parameters:
        caseId - Case number
        Returns:
        The case
        Throws:
        FB2GHException - if there is an API issue.

      • iterateCases

        Iterable<FBCase> iterateCases​(int minId,
                              int maxId)
                       throws FB2GHException
        Iterate multiple cases within a range.
        Parameters:
        minId - Case number to start at (inclusive)
        maxId - Case number to stop at (inclusive)
        Returns:
        An Iterable of the cases
        Throws:
        FB2GHException - if there is an API issue.

      • searchCases

        List<FBCase> searchCases​(String query)
                  throws FB2GHException
        Search for cases.
        Parameters:
        query - The query term you are searching for. Can be a string, a case number, a comma separated list of case numbers without spaces, e.g. 12,25,556. This search acts exactly the same way the search box in FogBugz operates. To search for the number 123 and not the case 123, enclose your search in quotes.
        Returns:
        A list containing the search results
        Throws:
        FB2GHException - if there is an API issue.

      • listCheckins

        List<FBCheckin> listCheckins​(FBCase fbCase)
                      throws FB2GHException
        Get a list of all checkins from this FogBugz instance.
        Parameters:
        fbCase - Only list checkins associated with this case.
        Returns:
        The list
        Throws:
        FB2GHException - if there is an API issue.

      • getBaseURL

        default String getBaseURL()

        Get the FogBugz URL.

        This method will return an empty String if left unimplemented.

        Returns:
        The URL of this FogBugz instance.

      • getAuthToken

        default String getAuthToken()

        Get the API token.

        This method will return an empty String if left unimplemented.

        Returns:
        The token parameter used to access the API.