Uses of Class
com.avoka.fc.core.entity.Client

Packages that use Client

Package	Description
com.avoka.fc.core.dao	Provides the Data Access Objects used by SmartForm Manager.
com.avoka.fc.core.entity	Provides the SmartForm Manager entity classes.
com.avoka.fc.core.entity.auto	Provides the SmartForm Manager entity base classes, which are being maintained by Cayenne.
com.avoka.fc.core.service	Provides the SmartForm Manager service classes.
com.avoka.fc.core.service.archive	Provides the SmartForm Manager portal import and export service.
com.avoka.fc.core.service.email	Provides the Email Client Services.
com.avoka.fc.core.service.fluent	Provides the Fluent Groovy API services.
com.avoka.fc.core.service.form	Provides classes for form services.
com.avoka.fc.core.service.impl	Provides the SmartForm Manager service class implementation.
com.avoka.fc.core.service.job	Provides Collaboration Jobs Service classes.
com.avoka.fc.core.service.job.impl	Provides Collaboration Jobs service classes.
com.avoka.fc.core.service.payment	Provides payment related utility classes.
com.avoka.fc.core.service.payment.reconciliation	Provides payment reconciliation related utility classes.
com.avoka.fc.core.service.storage	Provides submission data storage service implementations.
com.avoka.fc.core.service.test	Provides web automated test services.
com.avoka.fc.core.util	Provides common utility classes and exception objects.
com.avoka.tm.vo	Provides Value Object persistent entity classes.

Uses of Client in com.avoka.fc.core.dao

Fields in com.avoka.fc.core.dao with type parameters of type Client

Modifier and Type	Field	Description
List<Client>	WorkspaceDao.SubmissionCriteria.clientList	Client list filter.

Methods in com.avoka.fc.core.dao that return Client

Modifier and Type	Method	Description
Client	ClientDao.getClientByCode(String clientCode)	Return the client with the specified client code
Client	ClientDao.getClientByCodeRefresh(String clientCode)	Return the client with the specified client code.
Client	ClientDao.getClientByKey(String clientKey)	Return the client with the specified surrogate key
Client	ClientDao.getClientByName(String clientName)	Return the client with the specified name
Client	ClientDao.getClientByNormalizedCode(String clientCodeNormalized)	Return the client with the specified normalized client code
Client	ClientDao.getClientForPK(Object id)	Return the client with the specified OID

Methods in com.avoka.fc.core.dao that return types with arguments of type Client

Modifier and Type	Method	Description
List<Client>	ClientDao.getActiveClientList()	Return the list of all active clients, sorted by client name
List<Client>	UserAccountDao.getActiveClients(UserAccount userAccount)	Return the list of clients associated with the administrative user, will return empty list for global clients.
List<Client>	UserAccountDao.getAdministratorClients(String loginName)	Return a list of clients the administrator has access to.
List<Client>	ClientDao.getAllClients()	Return all clients, sorted by client name
List<Client>	ClientDao.getClientList(String keyword, boolean activeOnly)	Return the list of clients matching a set of search criteria
List<Client>	ClientDao.getClientsByPaymentGatewayType(ServiceDefinition paymentService)	Return the list of clients with the specified payment service.
List<Client>	ClientDao.getClientsSearch(String value)	Return the list of client whose name, code or description contain the search string, or whose OID matches the search string if it is numeric
List<Client>	ClientDao.getClientsWithoutKeys()	Return all clients for which no surrogate key is set

Methods in com.avoka.fc.core.dao with parameters of type Client

Modifier and Type	Method	Description
boolean	ServiceDefinitionDao.canCreateService(Client targetClient, String name)	Check whether a service with the specified client and name can be created without conflict.
boolean	ServiceConnectionDao.canCreateServiceConnection(Client targetClient, String name)	Check whether a service connection with the specified client and name can be created without conflict.
int	ClientReconciliationFileDao.deleteFilesBeforeDate(Client client, Date reconciliationTime)	Deletes any ClientReconciliationFile entities before the specified reconciliation time
String	ServiceDefinitionDao.generateUniqueServiceName(Client client, String serviceName)	Generates a unique (to the specified client) service name based on a suggested service name.
List<UserAccount>	UserAccountDao.getActiveUsersInGroupWithClientAccess(String groupName, Client client)	Return all active user accounts who are members of a specific group, ordered by login name.
ApplicationPackage	ApplicationPackageDao.getApplicationPackageForName(Client client, String applicationName)	Return the application package with the specified client and name
List<ApplicationPackage>	ApplicationPackageDao.getApplicationPackagesForClient(Client client, boolean activePackagesOnly)	Return the list of application packages for the given client.
List<Category>	CategoryDao.getCategoriesForClient(Client client)	Return the list of categories for the given client, ordered ascending by category name.
Category	CategoryDao.getCategoryByName(Client client, String name)	Return the category with the given name, for the given client.
String	ClientDao.getClientPropertyValue(Client client, String name)	Returns the client property value providing the client and property name.
List<ClientRefData>	ClientRefDataDao.getClientRefDataByClient(Client client)	Returns the ClientRefData if parameter is matched.
ClientRefData	ClientRefDataDao.getClientRefDataForNameLocale(Client client, String name, String locale)	Returns the ClientRefData if parameters are matched.
ServiceDefinition	ServiceDefinitionDao.getClientServiceWithFallback(Client client, String serviceName)	Return the current version service for the given client, service name, or null if none was found.
ServiceDefinition	ServiceDefinitionDao.getClientServiceWithFallback(Client client, String serviceName, Integer versionNumber)	Deprecated.
ServiceDefinition	ServiceDefinitionDao.getClientServiceWithFallback(Client client, String serviceName, String version)	Return the service for the given client, service name and version number, or null if none was found.
List<DeliveryDetails>	DeliveryDetailsDao.getClientWSDeliveryDetailsList(Client client)	Return the web service delivery details defined for a client
List<DeliveryDetails>	DeliveryDetailsDao.getDefaultDeliveryChannelForClient(Client client)	Return the default delivery channel for a client, or null if none is marked as default.
DeliveryDetails	DeliveryDetailsDao.getDeliveryDetailForClientAndName(Client client, String name)	Return a specific delivery details entry
ClientReconciliationFile	ClientReconciliationFileDao.getFileByTimestamp(Client client, Date reconciliationTime)	Return the client reconciliation file entity for a client and reconciliation time.
Form	FormDao.getFormByName(Client client, String name)	Return a form with the specified name belonging to a specific client
Form	FormDao.getFormByNormalizedName(Client client, String formNameNormalized)	Return a form with the given normalized name belonging to a specific client
int	TransactionHistoryDao.getFormRequestCount(Client client)	Deprecated.
int	TransactionHistoryDao.getFormSubmissionCount(Client client)	Deprecated.
List<MetadataTag>	MetadataTagDao.getMetadataTagListForClient(Client client)	Return the list of metadata tags who are associated with a specific client, sorted by name (global metadata tags are not included)
int	JobDao.getNumberOfJobsCreated(Date startDate, Date endDate, Client client)	Return the number of jobs created within a certain date range and optionally matching a specific client.
List<PromotionLog>	PromotionDao.getPromotionList(Client client, Form form, TemplateVersion version, boolean showHistory)	Return the list of promotion log records matching the specified search criteria, ordered by creation time.
ClientProperty	ClientPropertyDao.getProperty(Client client, String name)	Return the named client property or null if not defined
ClientProperty	ClientPropertyDao.getPropertyByVersion(Client client, String name, String version)	Return the named client property with specific version or null if not defined
String	ClientPropertyDao.getPropertyValue(Client client, String name)	Return the named client property value or null if not defined.
String	PropertyValueDao.getPropertyValue(String propertyName, Client client)	Return the named property value searching for: Client Property > Portal Property > Deployment Property.
String	PropertyValueDao.getPropertyValue(String propertyName, Client client, TemplateVersion version, Portal portal)	Return the named property value searching for: Form Property > Client Property > Portal Property > Deployment Property.
List<MetadataTag>	MetadataTagDao.getRequiredMetadataTagListForClient(Client client)	Return the list of required metadata tags who are associated with a specific client as well as global tags, sorted by name
int	SubmissionDao.getRequiredPaymentSubmissionsCount(int hours, Client client)	Return a list of the n submissions with a Payment Status of "Required" which are older than a configurable period of time in days.
ServiceConnection	ServiceConnectionDao.getServiceConnection(Client client, String name)	Return the service connection for the given service name and client (or the global service connection if client is null).
List<ServiceConnection>	ServiceConnectionDao.getServiceConnectionList(Client client)	Returns a List of service connection which include only the global service connection and the connections belonging to the organisation.
ServiceConnection	ServiceConnectionDao.getServiceConnectionWithFallback(Client client, String name)	Return the service connection for the given service name and client (or the global service connection if clientId is null).
List<ServiceDefinition>	ServiceDefinitionDao.getServiceDefinitionListForClient(Client client)	Return the list of service definitions for a client, ordered by type, then name
List<ServiceDefinition>	ServiceDefinitionDao.getServiceDefinitionListForClient(Client client, boolean activeServicesOnly)	Return the list of service definitions for a client, ordered by type, then name and version number
List<ServiceDefinition>	ServiceDefinitionDao.getServiceDefinitionListForType(String type, Client client, boolean includeInactiveServices)	Return the service definitions for the given type, sorted by type and name.
List<Submission>	SubmissionDao.getSubmissionsReadyForDelivery(Client client)	Return the list of submissions for a specified client that are ready to be delivered, ordered by submission time
List<String>	SubmissionDao.getSubmissionsReadyForWSDelivery(Client client)	Return the list of submissions that are ready for delivery via a web service delivery method
MetadataTag	MetadataTagDao.getTagByName(String name, Client client)	Return the metadata tag for the specified name and client
TPac	TPacDao.getTPacForProjectCode(Client client, String projectCode)	Return the TPac with the specified client and project code
List<TPac>	TPacDao.getTPacsForClient(Client client)	Return the list of TPac for the given client.
List<PaymentLog>	PaymentLogDao.getTransactionsByBatchNo(String batchNo, Client client, String serviceDefinitionCode)	Return payment log entries for the specified batch, client and payment service
boolean	MetadataTagDao.hasMetadataTags(Client client)	Return true if the client has metadata tags.
boolean	ServiceConnectionDao.hasServiceConnection(Client client, String name)	Return whether there is a service connection for the given service name
boolean	ServiceDefinitionDao.hasServiceDefinition(Client client, String serviceName)	Return whether there is at least one service definition with the given name Note: This method does not fall back to a global service if a clientId is specified.
void	ClientReconciliationFileDao.insertNewFile(Client client, String fileName, Date reconciliationTime, byte[] contents)	Insert a new ClientReconciliationFile object to represent the specified reconciliation file
protected final boolean	AbstractDao.isClientAccessAllowed(Client client)
boolean	UserAccountDao.isClientAccessibleToUser(UserAccount userAccount, Client client)	Checks if is user accessible to client.
boolean	ClientDao.isKeystoreRolloverRequired(Client client)	Return true if the client's key store requires rollover.
String	PropertyValueDao.renderEmailStringTemplate(String templateValue, Map model, Client client, TemplateVersion version, Portal portal)	Render the template string value with the model using the Velocity engine.
ClientKeystore	ClientKeystoreDao.saveClientKeystore(Client client, byte[] keystoreData, String createdBy)	Save the give key store data to the client.

Uses of Client in com.avoka.fc.core.entity

Methods in com.avoka.fc.core.entity with parameters of type Client

Modifier and Type	Method	Description
boolean	UserAccount.isAssociatedWithClient(Client client)	Return whether the user account is explicitly associated with the specified client (global access is not taken into account).

Uses of Client in com.avoka.fc.core.entity.auto

Fields in com.avoka.fc.core.entity.auto with type parameters of type Client

Modifier and Type	Field	Description
static final org.apache.cayenne.exp.Property<Client>	_ApplicationPackage.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Category.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientKeystore.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientMetadataValue.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientPortal.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientProperty.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientReconciliationFile.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientRefData.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ClientUser.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ComposerImportAction.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ComposerPackageQueue.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_DeliveryDetails.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_DocumentType.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ErrorLog.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Form.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_GroovyServiceLog.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ImportAction.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Job.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Library.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_LibraryShare.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_MetadataTag.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Notification.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Project.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_PromotionLog.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_PropertyType.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_RequestLog.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ServiceConnection.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_ServiceDefinition.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_Submission.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<Client>	_TPac.CLIENT	Provides the 'CLIENT' property.
static final org.apache.cayenne.exp.Property<List<Client>>	_ServiceDefinition.EMAIL_CLIENTS	Provides the 'EMAIL_CLIENTS' property.
static final org.apache.cayenne.exp.Property<List<Client>>	_ServiceDefinition.PAYMENT_CLIENTS	Provides the 'PAYMENT_CLIENTS' property.
static final org.apache.cayenne.exp.Property<List<Client>>	_ServiceDefinition.STORAGE_CLIENTS	Provides the 'STORAGE_CLIENTS' property.

Methods in com.avoka.fc.core.entity.auto that return Client

Modifier and Type	Method	Description
Client	_ApplicationPackage.getClient()	Return the Client.
Client	_Category.getClient()	Return the Client.
Client	_ClientKeystore.getClient()	Return the Client.
Client	_ClientMetadataValue.getClient()	Return the Client.
Client	_ClientPortal.getClient()	Return the Client.
Client	_ClientProperty.getClient()	Return the Client.
Client	_ClientReconciliationFile.getClient()	Return the Client.
Client	_ClientRefData.getClient()	Return the Client.
Client	_ClientUser.getClient()	Return the Client.
Client	_ComposerImportAction.getClient()	Return the Client.
Client	_ComposerPackageQueue.getClient()	Return the Client.
Client	_DeliveryDetails.getClient()	Return the Client.
Client	_DocumentType.getClient()	Return the Client.
Client	_ErrorLog.getClient()	Return the Client.
Client	_Form.getClient()	Return the Client.
Client	_GroovyServiceLog.getClient()	Return the Client.
Client	_ImportAction.getClient()	Return the Client.
Client	_Job.getClient()	Return the Client.
Client	_Library.getClient()	Return the Client.
Client	_LibraryShare.getClient()	Return the Client.
Client	_MetadataTag.getClient()	Return the Client.
Client	_Notification.getClient()	Return the Client.
Client	_Project.getClient()	Return the Client.
Client	_PromotionLog.getClient()	Return the Client.
Client	_PropertyType.getClient()	Return the Client.
Client	_RequestLog.getClient()	Return the Client.
Client	_ServiceConnection.getClient()	Return the Client.
Client	_ServiceDefinition.getClient()	Return the Client.
Client	_Submission.getClient()	Return the Client.
Client	_TPac.getClient()	Return the Client.

Methods in com.avoka.fc.core.entity.auto that return types with arguments of type Client

Modifier and Type	Method	Description
List<Client>	_ServiceDefinition.getEmailClients()	Return the EmailClients.
List<Client>	_ServiceDefinition.getPaymentClients()	Return the PaymentClients.
List<Client>	_ServiceDefinition.getStorageClients()	Return the StorageClients.

Methods in com.avoka.fc.core.entity.auto with parameters of type Client

Modifier and Type	Method	Description
void	_ServiceDefinition.addToEmailClients(Client obj)	Add the EmailClients object.
void	_ServiceDefinition.addToPaymentClients(Client obj)	Add the PaymentClients object.
void	_ServiceDefinition.addToStorageClients(Client obj)	Add the StorageClients object.
void	_ServiceDefinition.removeFromEmailClients(Client obj)	Remove the EmailClients object.
void	_ServiceDefinition.removeFromPaymentClients(Client obj)	Remove the PaymentClients object.
void	_ServiceDefinition.removeFromStorageClients(Client obj)	Remove the StorageClients object.
void	_ApplicationPackage.setClient(Client client)	Set the Client.
void	_Category.setClient(Client client)	Set the Client.
void	_ClientKeystore.setClient(Client client)	Set the Client.
void	_ClientMetadataValue.setClient(Client client)	Set the Client.
void	_ClientPortal.setClient(Client client)	Set the Client.
void	_ClientProperty.setClient(Client client)	Set the Client.
void	_ClientReconciliationFile.setClient(Client client)	Set the Client.
void	_ClientRefData.setClient(Client client)	Set the Client.
void	_ClientUser.setClient(Client client)	Set the Client.
void	_ComposerImportAction.setClient(Client client)	Set the Client.
void	_ComposerPackageQueue.setClient(Client client)	Set the Client.
void	_DeliveryDetails.setClient(Client client)	Set the Client.
void	_DocumentType.setClient(Client client)	Set the Client.
void	_ErrorLog.setClient(Client client)	Set the Client.
void	_Form.setClient(Client client)	Set the Client.
void	_GroovyServiceLog.setClient(Client client)	Set the Client.
void	_ImportAction.setClient(Client client)	Set the Client.
void	_Job.setClient(Client client)	Set the Client.
void	_Library.setClient(Client client)	Set the Client.
void	_LibraryShare.setClient(Client client)	Set the Client.
void	_MetadataTag.setClient(Client client)	Set the Client.
void	_Notification.setClient(Client client)	Set the Client.
void	_Project.setClient(Client client)	Set the Client.
void	_PromotionLog.setClient(Client client)	Set the Client.
void	_PropertyType.setClient(Client client)	Set the Client.
void	_RequestLog.setClient(Client client)	Set the Client.
void	_ServiceConnection.setClient(Client client)	Set the Client.
void	_ServiceDefinition.setClient(Client client)	Set the Client.
void	_Submission.setClient(Client client)	Set the Client.
void	_TPac.setClient(Client client)	Set the Client.

Uses of Client in com.avoka.fc.core.service

Methods in com.avoka.fc.core.service that return Client

Modifier and Type	Method	Description
Client	ClientService.createNewClient(String name, String code)	Create a new client given the client name and client code.

Methods in com.avoka.fc.core.service with parameters of type Client

Modifier and Type	Method	Description
protected ApplicationException	AbstractGroovyService.createExceptionAndLog(Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, Throwable cause, String context, String userMsg, String solution, Submission submission, Form form, Client client)	Create application exception and optionally log ErrorLog and GroovyServiceLog records if Groovy Logging enabled.
protected Object	AbstractGroovyService.executeGroovyScript(Map<String,Object> parameters, Client client)	Execute the service Groovy Script using the given parameters and security context client.
protected Object	AbstractGroovyService.executeGroovyScript(Map<String,Object> parameters, Client client, boolean commitChanges)	Execute the service Groovy Script using the given parameters and security context client.
static IHostedPaymentService	ServiceLocator.getHostedPaymentServiceForClient(Client client)	Returns the hosted payment service configured for the client
static IPaymentGatewayService	ServiceLocator.getPaymentGatewayService(Client client)	Returns the payment gateway service configured for the client
GroovyServiceLog	GroovyLogService.logServiceCall(ServiceDefinition serviceDefinition, Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, jakarta.servlet.http.HttpServletRequest request, Submission submission, Form form, Client client, ErrorLog errorLog, boolean debugEnabled, String funcTrigger)	Log Groovy Service invocation using the specified parameters.
void	ISubmissionDeliveryController.sendEmailEscalation(Client client, List<UserAccount> recipients, long numberOfEscalations)	Send a submission delivery escalation email.
void	SystemAlertService.sendSystemAlert(String message, String groupName, Client client)	Sent TM System Alert error email to the specified alert group members who can access the specified client, or if no client was specified, have global access.
void	SystemAlertService.sendSystemAlerts(List<String> messages, String groupName, Client client)	Send TM System Alert email to messages to the specified alert group members who can access the specified client, or if no client was specified, have global access.
void	ClientService.updateClientPortals(Client client, List<Long> newPortalIds)	Update the client to be associated with the given set of portals

Uses of Client in com.avoka.fc.core.service.archive

Methods in com.avoka.fc.core.service.archive with parameters of type Client

Modifier and Type	Method	Description
protected ServiceConnection	BaseArchiveService.importServiceConnection(Client client, ServiceDefinition serviceDefinition, boolean preserveServiceConnections, Element connectionElement, List<String> warnings)
protected void	BaseArchiveService.importServiceDefinition(Client client, ApplicationPackage application, boolean preserveExistingServices, boolean preserveDefaultServices, boolean preserveServiceConnections, Element serviceElement, List<String> warnings)
protected ApplicationPackage	BaseArchiveService.readApplicationPackageReference(Element parentElement, Client targetClient)
protected ServiceDefinition	BaseArchiveService.readServiceReference(Element serviceElement, Client client)	Read a service definition defined in a special service element

Uses of Client in com.avoka.fc.core.service.email

Methods in com.avoka.fc.core.service.email with parameters of type Client

Modifier and Type	Method	Description
protected ApplicationException	GroovyEmailService.createExceptionAndLog(Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, Throwable cause, String context, String userMsg, String solution, Submission submission, Form form, Client client)	Create application exception and optionally log ErrorLog and GroovyServiceLog records if Groovy Logging enabled.
protected Object	GroovyEmailService.executeGroovyScript(Map<String,Object> parameters, Client client)	Execute the service Groovy Script using the given parameters and security context client.

Uses of Client in com.avoka.fc.core.service.fluent

Methods in com.avoka.fc.core.service.fluent that return Client

Modifier and Type	Method	Description
protected Client	AbstractFluentService.getClient()

Methods in com.avoka.fc.core.service.fluent with parameters of type Client

Modifier and Type	Method	Description
String	FluentJobActionService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.

Uses of Client in com.avoka.fc.core.service.form

Fields in com.avoka.fc.core.service.form declared as Client

Modifier and Type	Field	Description
Client	FormBean.client	The client which this form belongs to.

Methods in com.avoka.fc.core.service.form with parameters of type Client

Modifier and Type	Method	Description
String	FormService.generateClientUniqueFormName(Client client, String name)	Create a form name unique within the organization by appending a number starting at 2 to the name.

Uses of Client in com.avoka.fc.core.service.impl

Methods in com.avoka.fc.core.service.impl with parameters of type Client

Modifier and Type	Method	Description
void	SubmissionDeliveryControllerService.sendEmailEscalation(Client client, List<UserAccount> recipients, long numberOfEscalations)	Send a submission delivery escalation email.

Uses of Client in com.avoka.fc.core.service.job

Methods in com.avoka.fc.core.service.job with parameters of type Client

Modifier and Type	Method	Description
Job	IJobController.createJobWithClient(Client client)	Create a job with the client, initializing the first step and action and put in 'Ready' state.
String	IJobActionService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.

Uses of Client in com.avoka.fc.core.service.job.impl

Methods in com.avoka.fc.core.service.job.impl with parameters of type Client

Modifier and Type	Method	Description
Job	JobControllerService.createJobWithClient(Client client)
static String	JobFunctions.validateFuncCall(Client client, String propertyValue)	Validate the job function call property value, returning null if valid or the error message if not valid.
String	AbstractJobActionService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.
String	JobDeliveryService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.
String	JobFormStartService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.
String	JobProcessMessageService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.
String	JobTaskAssignService.validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.
static String	JobActionUtils.validatePropertyIsForm(ActionStepProperties actionStepProperties, String formCodePropertyName, Client client, String versionPropertyName)	Validate the given actionStepProperties ensuring the given propertyName value is a valid form code if defined
static String	JobActionUtils.validatePropertyIsFormCode(ActionStepProperties actionStepProperties, String propertyName, Client client)	Deprecated. use validatePropertyIsForm.
static String	JobActionUtils.validatePropertyIsPortal(ActionStepProperties actionStepProperties, String propertyName, Client client)	Validate the given actionStepProperties ensuring the given propertyName value is a Portal if defined

Uses of Client in com.avoka.fc.core.service.payment

Methods in com.avoka.fc.core.service.payment with parameters of type Client

Modifier and Type	Method	Description
PaymentLog	IHostedPaymentService.identifyTransaction(Client client, jakarta.servlet.http.HttpServletRequest request)	Attempt to lookup a payment log entry using the supplied HTTP request

Uses of Client in com.avoka.fc.core.service.payment.reconciliation

Methods in com.avoka.fc.core.service.payment.reconciliation with parameters of type Client

Modifier and Type	Method	Description
static Date	ReconciliationUtils.calculateSettlementDate(Client client, Date requestTimestamp)	This method calculate the settlement date for a timestamp.
static String	ReconciliationFile.formatKey(Client client, Date dateStamp)	format a file key to identify the file in the file cache
Map<String,Object>	IFileBasedReconciliation.getCsvConfig(Client client)	Return the hash map of configuration values used to define the structure of the reconciliation file
static Date	ReconciliationUtils.getFileDateForLastReconciliationFile(Client client, Date nowDate)	Work out the date for the last reconcilaiton file that should have been received.
static Map<String,ReconciliationFile>	ReconciliationUtils.importReconciliationFile(Client client, String fileName, Date settlementDate, byte[] fileContent, Map<String,Object> config)	Load the specified reconciliation file into the cache.
static ReconciliationFile	ReconciliationUtils.loadReconciliatonFile(Map<String,ReconciliationFile> reconciliationFiles, Client client, Date dateStamp, Map<String,Object> csvConfig)	Load the specified reconciliation file into the cache.
static void	ReconciliationUtils.processReconciliationFile(Client client, String fileName, Date settlementDate, byte[] fileContent, IFileBasedReconciliation paymentGateway)	Resolve any payment transactions within the reconciliation file for the specified date.
static void	ReconciliationUtils.purgeOldReconciliationFiles(IFileBasedReconciliation paymentGateway, Client client)	Purge old reconciliation files from the database.
static Date	ReconciliationUtils.setTimeToBatchCutOff(Client client, Date date)	Set the time part of the specified date to the time stamp of the batch cut off for that day.

Constructors in com.avoka.fc.core.service.payment.reconciliation with parameters of type Client

Modifier	Constructor	Description
	ReconciliationFile(Client client, String fileName, byte[] contents, Date fileDate, Map<String,Object> csvConfig)	Create a ReconciliationFile object from the specified byte array.
	ReconciliationFile(Client client, String fileName, String contents, Date fileDate, Map<String,Object> csvConfig)	Create a ReconciliationFile object from the specified content.

Uses of Client in com.avoka.fc.core.service.storage

Methods in com.avoka.fc.core.service.storage with parameters of type Client

Modifier and Type	Method	Description
void	ClientKeyStoreService.intializeClientKeystore(Client client, String createdBy)	Initialize the client key store

Uses of Client in com.avoka.fc.core.service.test

Methods in com.avoka.fc.core.service.test that return Client

Modifier and Type	Method	Description
Client	MockEntityService.createClient(String name)	Create a client with the given name.
Client	MockEntityService.createClient(String name, String code)	Create a client with the given name and code.
Client	MockEntityService.getOrCreateClient(String testName)	Get the current client if executing in GroovyScript Unit Test context with a client defined, or create a new test client otherwise.

Methods in com.avoka.fc.core.service.test with parameters of type Client

Modifier and Type	Method	Description
ClientPortal	MockEntityService.addClientToPortal(Client client, Portal portal)	Add a client to the specified portal This method does NOT check if the portal already has that client.
ClientUser	MockEntityService.addClientToUser(UserAccount userAccount, Client client)	Add a client to the specified user account This method does NOT check if the user already has that client.
ApplicationPackage	MockEntityService.createApplicationPackage(String name, Client client)	Create an application package with the given name and client
Category	MockEntityService.createCategory(Client client, String name, String description)	Create a category.
ClientProperty	MockEntityService.createClientProperty(Client client, PropertyType propertyType, String value)	Create a client property value for a client and property type.
DeliveryDetails	MockEntityUtils.createDeliveryDetails(Client client, String name, String method)	Create a basic delivery channel for the given client.
Form	MockEntityService.createForm(String formCode, Client client, Portal portal)	Create a new form with the given formCode, client and portal.
Form	MockEntityService.createForm(String formCode, Client client, Collection<Portal> portals)	Create a new form with the given formCode, client and portal.
GroovyServiceLog	MockEntityService.createGroovyServiceLog(Client client, Submission submission, ServiceDefinition serviceDefinition, ErrorLog errorLog)	Create a mock GroovyServiceLog for the given parameters.
Job	MockEntityService.createJobInProgress(Client client)	Create an Job for the given client with an 'In Progress' status.
Job	MockEntityService.createJobInProgress(Client client, String formXml)	Create an Job for the given client with an 'In Progress' status.
ServiceDefinition	MockEntityService.createJobServiceDefinition(Client client, String svcName, String svcVersion)	Create JobController Service Definition
Job	MockEntityService.createJobWithFormXml(Client client, String jobDefJson, Form form, String formXmlData)	Create a mock collaboration job for the given jobDefinition and Client
Job	MockEntityService.createJobWithGroupInProgress(Client client, String formXml)	Create a Job with a group for the given client with an 'In Progress' status.
Job	MockEntityService.createJobWithSubmission(Client client, String jobDefJson, Submission submission)	Create a mock collaboration job for the given jobDefinition and Client
ServiceConnection	MockEntityService.createKafkaServiceConnection(String name, String kafkaServer, String userName, String pass, Client client, String jsonConfig)	Create a new Kafka Service Connection
Project	MockEntityService.createProject(Client client, String name)	Create project with given name for a client.
PropertyType	MockEntityService.createPropertyType(String name, String scope, String dataType, Client client)	Create a property type, optionally associated with a client
ServiceConnection	MockEntityService.createServiceConnection(String name, String serverType, Client client)	Create a new Service Connection
ServiceDefinition	MockEntityService.createServiceDefinition(String name, String versionNumber, String serviceType, String className, Client client)	Create an active service definition with the given name, version number, type, class and optionally client This method sets the active flag and potentially the current version flag (if no other version of the same service exists) Other settings have to be set on the service definition after creation, e.g.
Submission	MockEntityService.createSubmissionCompletedWithXml(String formXmlData, Client client)	Create a completed Submission entity with the given XML form data and client.
Submission	MockEntityService.createSubmissionOpened(Client client)	Create a opened Submission entity with the given client.
Submission	MockEntityService.createSubmissionSavedWithXml(String formXmlData, Client client)	Create a saved Submission entity with the given XML form data and client.
Submission	MockEntityService.createSubmissionSubmittedWithXml(String formXmlData, Client client)	Create a submitted Submission entity with the given XML form data and client.
Submission	MockEntityService.createSubmissionTaskWithXml(String formXmlData, Client client)	Create an assigned Submission form task entity with the given XML form data and client.
Submission	MockEntityService.createSubmissionWithClientStatusXml(Client client, String formStatus, String formXmlData)	Create a Submission entity with the given client, form status and XML form data.
TPac	MockEntityService.createTPac(String projectCode, Client client)	Create a tpac with the given code and client

Uses of Client in com.avoka.fc.core.util

Methods in com.avoka.fc.core.util that return Client

Modifier and Type	Method	Description
Client	ApplicationException.getClient()	Return the client.

Methods in com.avoka.fc.core.util with parameters of type Client

Modifier and Type	Method	Description
static Map<String,Integer>	DataRetentionUtils.getRetentionPolicyRange(String retentionParameterName, Client client, Form form)	Return the possible range in days for a data retention parameter, as well as (on client and form levels) information on the inherited value.
static SubmissionRetentionSettings	DataRetentionUtils.getSubmissionRetentionDefaults(Client client)	Calculate the global/organization default values that apply to data retention policies for the given client.
static SubmissionRetentionSettings	DataRetentionUtils.getSubmissionRetentionThresholds(Client client)	Calculate the upper limits that apply to data retention policies for the given client.
void	ApplicationException.setClient(Client client)	Set the client.

Constructors in com.avoka.fc.core.util with parameters of type Client

Modifier	Constructor	Description
	GroovyThreadListener(Client client)	Create a new Groovy Thread listener to be passed onto another execution thread.

Uses of Client in com.avoka.tm.vo

Constructors in com.avoka.tm.vo with parameters of type Client

Modifier	Constructor	Description
	Client(Client client)	Create a Client value object with the given client entity parameter.