Package dev.getelements.elements.sdk.service.application

Interface ApplicationService

All Known Implementing Classes:
AnonApplicationService, SuperUserApplicationService
public interface ApplicationService
Manages the lifecycle of the Application instance. Created by patricktwohig on 7/10/15.

  • Method Details

    • createApplication

      Application createApplication(CreateApplicationRequest applicationRequest)
      Creates a new application and inserts it into the database. The retruned value represents the CreateApplicationRequest as it was inserted into the database.
      Parameters:
      applicationRequest - the application
      Returns:
      the application

    • getApplications

      Pagination<Application> getApplications()
      Lists all Application instances avaiable to the current user.
      Returns:
      a Pagination<Application> for all available instances.

    • getApplications

      Pagination<Application> getApplications(int offset, int count)
      Gets the applications registered in the databse given the offset and count.
      Parameters:
      offset - the offset
      count - the count
      Returns:
      a Pagination of Application instances

    • getApplications

      Pagination<Application> getApplications(int offset, int count, String search)
      Gets the applications registered in the databse given the offset and count.
      Parameters:
      offset - the offset
      count - the count
      search - a query to filter the results
      Returns:
      a Pagination of Application instances

    • getApplication

      Application getApplication(String nameOrId)
      Gets an application with the specific name or identifier.

    • updateApplication

      Application updateApplication(String nameOrId, UpdateApplicationRequest applicationRequest)
      Updates an application with the specific name/identifiers.
      Parameters:
      nameOrId - the name, or id
      applicationRequest - the UpdateApplicationRequest object to write
      Returns:
      the Application object as it was persisted to the database.

    • deleteApplication

      void deleteApplication(String nameOrId)
      Deletes an Application with the specific name or identifier.
      Parameters:
      nameOrId - the name, or id