Package com.avoka.fc.core.dao

Class DeliveryDetailsDao

java.lang.Object
com.avoka.core.dao.BaseDao
com.avoka.fc.core.dao.AbstractDao
com.avoka.fc.core.dao.DeliveryDetailsDao
public class DeliveryDetailsDao extends AbstractDao
Provides a DAO for the DeliveryDetails entity.
See Also:

  • Constructor Details

    • DeliveryDetailsDao

      public DeliveryDetailsDao()

  • Method Details

    • getDeliveryDetailsForPK

      public DeliveryDetails getDeliveryDetailsForPK(Object id)
      Return the delivery details for the given primary key.
      Parameters:
      id - the delivery details
      Returns:
      the delivery details for the given primary key

    • hasDeliveryDetailsForName

      public boolean hasDeliveryDetailsForName(String name)
      Return true if there are delivery details available for the given name.
      Parameters:
      name - the name of the the delivery details
      Returns:
      true if there are delivery details available for the given name
      Since:
      4.0.0

    • getDeliveryDetailsList

      public List<DeliveryDetails> getDeliveryDetailsList(String clientId)
      Return a list of available delivery details ordered by name.
      Parameters:
      clientId - the client to which the delivery details belong (optional)
      Returns:
      a list of available delivery details ordered by name

    • getDeliveryDetailForClientAndName

      public DeliveryDetails getDeliveryDetailForClientAndName(Client client, String name)
      Return a specific delivery details entry
      Parameters:
      client - the non-null client to which the delivery details belong
      name - the non-empty name of the delivery details
      Returns:
      the delivery details object with the specified name that belongs to the specified client, or null if no such delivery details exist

    • getDefaultDeliveryChannelForClient

      public List<DeliveryDetails> getDefaultDeliveryChannelForClient(Client client)
      Return the default delivery channel for a client, or null if none is marked as default.
      Parameters:
      client - the non-null client to which the delivery details belong
      Returns:
      the default delivery details object that belongs to the specified client, or null if no such delivery channel exists. Generally there should be only one entry in the list.
      Since:
      5.1.0

    • getClientWSDeliveryDetailsList

      public List<DeliveryDetails> getClientWSDeliveryDetailsList(Client client)
      Return the web service delivery details defined for a client
      Parameters:
      client - the client
      Returns:
      the list of delivery details for the client that have DeliveryDetails.METHOD_WEB_SERVICE as their delivery method

    • getDeliveryDetailsListForClient

      public List<DeliveryDetails> getDeliveryDetailsListForClient(String clientId)
      Return the list of delivery details for a client, sorted by name
      Parameters:
      clientId - the client OID
      Returns:
      the list of all delivery details defined for the client

    • getPotentialDeliveryDetailsQueryForForm

      public org.apache.cayenne.query.SelectQuery getPotentialDeliveryDetailsQueryForForm(String formId)
      Return a query that can be used to retrieve the list of delivery details that can be used for a specific form
      Parameters:
      formId - the form OID
      Returns:
      the form-specific SelectQuery

    • getAvailableDeliveryMethods

      public String[] getAvailableDeliveryMethods()
      Return the list of delivery methods. By default, this includes all methods defined in DeliveryDetails.DELIVERY_METHODS. However, this can be overwritten by changing the value of DeploymentProperty.PROPERTY_Supported_Delivery_Methods.
      Returns:
      the list of supported delivery methods

    • getAllDeliveryMethodsString

      public String getAllDeliveryMethodsString()
      Returns a concatenation of all delivery methods, separated by commas
      Returns:
      a string containing all delivery methods defined in DeliveryDetails.DELIVERY_METHODS

    • createDefaultTrashCanDeliveryProcess

      public void createDefaultTrashCanDeliveryProcess(Client client)
      Creates a default trash can delivery process
      Parameters:
      client - the client
      Since:
      23.10.0