Package com.avoka.tm.svc

Class StatusService

java.lang.Object
com.avoka.tm.svc.StatusService
public class StatusService extends Object

Provides a status updater and status retrieval class for Client, Form, Portal and TemplateVersion.

Examples

Please find the Status updater examples below.

Set Client Status

This Groovy example shows how to update a Client status to Active

 import com.avoka.tm.svc.*;

 new StatusService()
     .setClient("clientCode")
     .setStatus("Active")
     .update()

Set form status and form version simultaneously

This Groovy example shows how to update a form status and form version status to Offline simultaneously 

 import com.avoka.tm.svc.*

 new StatusService()
       .setForm("formCode")
       .setTemplateVersion("formCode", "versionNumber")
       .setStatus("Offline")
       .update()

Get Portal Status

This Groovy example shows how to get portal status with using portal Name 

 import com.avoka.tm.svc.*

 new StatusService()
         .getPortalStatus("portalName")
Since:
21.11

  • Constructor Details

    • StatusService

      public StatusService()
      Create StatusService.

  • Method Details

    • setClient

      public StatusService setClient(String clientCode)
      Set the Client for which the status has to be set.
      Parameters:
      clientCode - Client code
      Returns:
      the StatusService

    • setForm

      public StatusService setForm(String formCode)
      Set the Form for which the status has to be set.
      Parameters:
      formCode - Form code
      Returns:
      the StatusService

    • setTemplateVersion

      public StatusService setTemplateVersion(String formCode, String versionNumber)
      Set the Form Version for which the status has to be set.
      Parameters:
      formCode - Form code associated with template version
      versionNumber - Version number
      Returns:
      the StatusService

    • setPortal

      public StatusService setPortal(String portalName)
      Set the Portal for which the status has to be set.
      Parameters:
      portalName - Portal Name
      Returns:
      the StatusService

    • setStatus

      public StatusService setStatus(String statusType)
      Set the status to be set for the entity.
      Parameters:
      statusType - Status type
      Returns:
      the StatusService

    • update

      public void update()
      Update the identified entities with the specified status.

    • getStatus

      public String getStatus()
      Retrieve the status of the set entity.
      Returns:
      Status of the set entity.

    • getClientStatus

      public String getClientStatus(String clientCode)
      Get the client Status for the specified Client Code.
      Parameters:
      clientCode - Client code
      Returns:
      the Client status

    • getFormStatus

      public String getFormStatus(String formCode)
      Get the form Status for the specified form Code.
      Parameters:
      formCode - Form code
      Returns:
      the Form status

    • getPortalStatus

      public String getPortalStatus(String portalName)
      Get the portal Status for the specified portal name.
      Parameters:
      portalName - portal Name
      Returns:
      the Portal status

    • getTemplateVersionStatus

      public String getTemplateVersionStatus(String formCode, String versionNumber)
      Get the Form Version status for the specified form code and version Number.
      Parameters:
      formCode - Form code associated with template version
      versionNumber - Version number
      Returns:
      the form version status