Interface StatusesServiceLocal


  • public interface StatusesServiceLocal
    Local interface for the Statuses service from the Planner API
    • Method Detail

      • getStatuses

        java.util.List<Status> getStatuses​(java.lang.String type)
                                    throws PubServerException
        Returns statuses at the specified type
        Parameters:
        type - type of the status
        Returns:
        the list of statuses
        Throws:
        PubServerException
        See Also:
        Status
      • getStatus

        Status getStatus​(java.lang.String id)
                  throws PubServerException,
                         java.lang.NumberFormatException
        Returns the status at the specified ID
        Parameters:
        id - status ID
        Returns:
        the status
        Throws:
        PubServerException
        java.lang.NumberFormatException
        See Also:
        Status
      • addStatuses

        java.util.List<Status> addStatuses​(java.util.List<Status> statuses)
                                    throws PubServerException
        Adds new statuses
        Parameters:
        statuses - the list of new statuses to create
        Returns:
        the list of processed status
        Throws:
        PubServerException
        See Also:
        Status
      • deleteStatus

        boolean deleteStatus​(java.lang.String id)
                      throws PubServerException
        Deletes the status at the specified ID
        Parameters:
        id - status ID
        Returns:
        true if success
        Throws:
        PubServerException
      • getStatusesByStatusGroupID

        java.util.List<Status> getStatusesByStatusGroupID​(java.lang.String statusGroupID,
                                                          java.lang.String statusType)
                                                   throws PubServerException
        Returns statuses from the specified status group and status type
        Parameters:
        statusGroupID - status group ID
        statusType - status type
        Returns:
        the list of statuses
        Throws:
        PubServerException
        See Also:
        Status, StatusGroupsServiceLocal
      • setStatusesForStatusGroup

        java.util.List<Status> setStatusesForStatusGroup​(java.lang.String statusGroupID,
                                                         java.util.List<Status> statuses)
                                                  throws PubServerException
        Assigns statuses to the specified status group
        Parameters:
        statusGroupID - status group ID
        statuses - the list of statuses
        Returns:
        the list of processed statuses
        Throws:
        PubServerException
        See Also:
        Status, StatusGroupsServiceLocal
      • addStatusesToStatusGroup

        java.util.List<Status> addStatusesToStatusGroup​(java.lang.String statusGroupID,
                                                        java.util.List<Status> statuses)
                                                 throws PubServerException
        Adds new statuses to the specified status group
        Parameters:
        statusGroupID - status group ID
        statuses - the list of statuses to add
        Returns:
        the list of processed statuses
        Throws:
        PubServerException
        See Also:
        Status, StatusGroupsServiceLocal