Package com.avoka.fc.core.entity
Class Client
java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._Client
com.avoka.fc.core.entity.Client
- All Implemented Interfaces:
IEntity
,Auditable
,Serializable
,org.apache.cayenne.DataObject
,org.apache.cayenne.Persistent
,org.apache.cayenne.Validating
Provides a client (or organization) entity. Other entities (such as forms) are often associated with a specific client.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The 'Annually' keystore rollover policy.static final String
The 'Daily' keystore rollover policy.static final String
The 'Monthly' keystore rollover policy.static final String[]
The keystore rollover policies.static final String
The 'Weekly' keystore rollover policy.static final String
The TM Server Monitor client code.Fields inherited from class com.avoka.fc.core.entity.auto._Client
APPLICATION_PACKAGES, APPLICATION_PACKAGES_PROPERTY, BROWSER_IE10FLAG, BROWSER_IE10FLAG_PROPERTY, BROWSER_IE8FLAG, BROWSER_IE8FLAG_PROPERTY, BROWSER_IE9FLAG, BROWSER_IE9FLAG_PROPERTY, BROWSER_OVERRIDE_FLAG, BROWSER_OVERRIDE_FLAG_PROPERTY, CATEGORIES, CATEGORIES_PROPERTY, CLIENT_CODE, CLIENT_CODE_NORMALIZED, CLIENT_CODE_NORMALIZED_PROPERTY, CLIENT_CODE_PROPERTY, CLIENT_DESCRIPTION, CLIENT_DESCRIPTION_PROPERTY, CLIENT_KEY, CLIENT_KEY_PROPERTY, CLIENT_KEYSTORES, CLIENT_KEYSTORES_PROPERTY, CLIENT_METADATA_VALUES, CLIENT_METADATA_VALUES_PROPERTY, CLIENT_NAME, CLIENT_NAME_PROPERTY, CLIENT_OID_PK_COLUMN, CLIENT_PORTALS, CLIENT_PORTALS_PROPERTY, CLIENT_PROPERTIES, CLIENT_PROPERTIES_PROPERTY, CLIENT_RECONCILIATION_FILES, CLIENT_RECONCILIATION_FILES_PROPERTY, CLIENT_REF_DATAS, CLIENT_REF_DATAS_PROPERTY, CLIENT_USERS, CLIENT_USERS_PROPERTY, COMPOSER_IMPORT_ACTIONS, COMPOSER_IMPORT_ACTIONS_PROPERTY, COMPOSER_PACKAGES, COMPOSER_PACKAGES_PROPERTY, CREATED_AT, CREATED_AT_PROPERTY, CREATED_BY, CREATED_BY_PROPERTY, CURRENT_KEYSTORE, CURRENT_KEYSTORE_PROPERTY, DELIVERY_DETAILS, DELIVERY_DETAILS_PROPERTY, DOCUMENT_TYPES, DOCUMENT_TYPES_PROPERTY, EMAIL_SERVICE, EMAIL_SERVICE_PROPERTY, ERROR_LOGS, ERROR_LOGS_PROPERTY, FORM_CSP_HEADERS, FORM_CSP_HEADERS_OVERRIDE_FLAG, FORM_CSP_HEADERS_OVERRIDE_FLAG_PROPERTY, FORM_CSP_HEADERS_PROPERTY, FORMS, FORMS_PROPERTY, GROOVY_SERVICE_LOG, GROOVY_SERVICE_LOG_PROPERTY, IMPORT_ACTIONS, IMPORT_ACTIONS_PROPERTY, JOB_MAX_ABANDON_AGE, JOB_MAX_ABANDON_AGE_PROPERTY, JOB_MAX_DATA_AGE, JOB_MAX_DATA_AGE_PROPERTY, JOBS, JOBS_PROPERTY, KEYSTORE_ROLLOVER_POLICY, KEYSTORE_ROLLOVER_POLICY_PROPERTY, LAST_MODIFIED_AT, LAST_MODIFIED_AT_PROPERTY, LAST_MODIFIED_BY, LAST_MODIFIED_BY_PROPERTY, LIBRARIES, LIBRARIES_PROPERTY, LIBRARY_SHARES, LIBRARY_SHARES_PROPERTY, METADATA_TAGS, METADATA_TAGS_PROPERTY, PAYMENT_ACCESS_CODE, PAYMENT_ACCESS_CODE_PROPERTY, PAYMENT_BATCH_CUTOFF_TIME, PAYMENT_BATCH_CUTOFF_TIME_PROPERTY, PAYMENT_CUSTOM_PARAM1, PAYMENT_CUSTOM_PARAM1_PROPERTY, PAYMENT_CUSTOM_PARAM2, PAYMENT_CUSTOM_PARAM2_PROPERTY, PAYMENT_CUSTOM_PARAM3, PAYMENT_CUSTOM_PARAM3_PROPERTY, PAYMENT_CUSTOM_PARAM4, PAYMENT_CUSTOM_PARAM4_PROPERTY, PAYMENT_MERCHANT_ID, PAYMENT_MERCHANT_ID_PROPERTY, PAYMENT_MERCHANT_PASSWORD, PAYMENT_MERCHANT_PASSWORD_PROPERTY, PAYMENT_MERCHANT_USER, PAYMENT_MERCHANT_USER_PROPERTY, PAYMENT_SECURE_HASH, PAYMENT_SECURE_HASH_PROPERTY, PAYMENT_SERVICE, PAYMENT_SERVICE_PROPERTY, PROJECTS, PROJECTS_PROPERTY, PROMOTION_LOG, PROMOTION_LOG_PROPERTY, PROPERTY_TYPES, PROPERTY_TYPES_PROPERTY, REQUEST_LOG, REQUEST_LOG_PROPERTY, SERVICE_CONNECTIONS, SERVICE_CONNECTIONS_PROPERTY, SERVICE_DEFINITIONS, SERVICE_DEFINITIONS_PROPERTY, STATUS, STATUS_PROPERTY, STORAGE_SERVICE, STORAGE_SERVICE_PROPERTY, SUB_MAX_AGE_DATA_DELIVERED, SUB_MAX_AGE_DATA_DELIVERED_PROPERTY, SUB_MAX_AGE_DATA_SAVED, SUB_MAX_AGE_DATA_SAVED_PROPERTY, SUBMISSION_ENCODING, SUBMISSION_ENCODING_PROPERTY, SUBMISSIONS, SUBMISSIONS_PROPERTY, SUPPORTS_AMEX, SUPPORTS_AMEX_PROPERTY, SUPPORTS_DINERS_CLUB, SUPPORTS_DINERS_CLUB_PROPERTY, SUPPORTS_MASTER_CARD, SUPPORTS_MASTER_CARD_PROPERTY, SUPPORTS_VISA, SUPPORTS_VISA_PROPERTY, TPACS, TPACS_PROPERTY
Fields inherited from class com.avoka.core.entity.BaseEntity
ID_PROPERTY
Fields inherited from class org.apache.cayenne.CayenneDataObject
values
Fields inherited from class org.apache.cayenne.BaseDataObject
snapshotVersion
Fields inherited from class org.apache.cayenne.PersistentObject
objectContext, objectId, persistenceState
Fields inherited from interface org.apache.cayenne.DataObject
DEFAULT_VERSION
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetClientPortal
(Portal portal) Return the client portal for the given portal.Return the default delivery details for the client, or null if not defined.boolean
hasAccessToPortal
(Portal portal) Return whether the client has access to the given portalboolean
isActive()
Return whether the client is activeboolean
Return the whether the job abandonment date is set based on associated client's job abandon age.Methods inherited from class com.avoka.fc.core.entity.auto._Client
addToApplicationPackages, addToCategories, addToClientKeystores, addToClientMetadataValues, addToClientPortals, addToClientProperties, addToClientReconciliationFiles, addToClientRefDatas, addToClientUsers, addToComposerImportActions, addToComposerPackages, addToDeliveryDetails, addToDocumentTypes, addToErrorLogs, addToForms, addToGroovyServiceLog, addToImportActions, addToJobs, addToLibraries, addToLibraryShares, addToMetadataTags, addToProjects, addToPromotionLog, addToPropertyTypes, addToRequestLog, addToServiceConnections, addToServiceDefinitions, addToSubmissions, addToTpacs, getApplicationPackages, getCategories, getClientCode, getClientCodeNormalized, getClientDescription, getClientKey, getClientKeystores, getClientMetadataValues, getClientName, getClientPortals, getClientProperties, getClientReconciliationFiles, getClientRefDatas, getClientUsers, getComposerImportActions, getComposerPackages, getCreatedAt, getCreatedBy, getCurrentKeystore, getDeliveryDetails, getDocumentTypes, getEmailService, getErrorLogs, getFormCspHeaders, getForms, getGroovyServiceLog, getImportActions, getJobMaxAbandonAge, getJobMaxDataAge, getJobs, getKeystoreRolloverPolicy, getLastModifiedAt, getLastModifiedBy, getLibraries, getLibraryShares, getMetadataTags, getPaymentAccessCode, getPaymentBatchCutoffTime, getPaymentCustomParam1, getPaymentCustomParam2, getPaymentCustomParam3, getPaymentCustomParam4, getPaymentMerchantId, getPaymentMerchantPassword, getPaymentMerchantUser, getPaymentSecureHash, getPaymentService, getProjects, getPromotionLog, getPropertyTypes, getRequestLog, getServiceConnections, getServiceDefinitions, getStatus, getStorageService, getSubMaxAgeDataDelivered, getSubMaxAgeDataSaved, getSubmissionEncoding, getSubmissions, getTpacs, isBrowserIe10Flag, isBrowserIe8Flag, isBrowserIe9Flag, isBrowserOverrideFlag, isFormCspHeadersOverrideFlag, isSupportsAmex, isSupportsDinersClub, isSupportsMasterCard, isSupportsVisa, removeFromApplicationPackages, removeFromCategories, removeFromClientKeystores, removeFromClientMetadataValues, removeFromClientPortals, removeFromClientProperties, removeFromClientReconciliationFiles, removeFromClientRefDatas, removeFromClientUsers, removeFromComposerImportActions, removeFromComposerPackages, removeFromDeliveryDetails, removeFromDocumentTypes, removeFromErrorLogs, removeFromForms, removeFromGroovyServiceLog, removeFromImportActions, removeFromJobs, removeFromLibraries, removeFromLibraryShares, removeFromMetadataTags, removeFromProjects, removeFromPromotionLog, removeFromPropertyTypes, removeFromRequestLog, removeFromServiceConnections, removeFromServiceDefinitions, removeFromSubmissions, removeFromTpacs, setBrowserIe10Flag, setBrowserIe8Flag, setBrowserIe9Flag, setBrowserOverrideFlag, setClientCode, setClientCodeNormalized, setClientDescription, setClientKey, setClientName, setCreatedAt, setCreatedBy, setCurrentKeystore, setEmailService, setFormCspHeaders, setFormCspHeadersOverrideFlag, setJobMaxAbandonAge, setJobMaxDataAge, setKeystoreRolloverPolicy, setLastModifiedAt, setLastModifiedBy, setPaymentAccessCode, setPaymentBatchCutoffTime, setPaymentCustomParam1, setPaymentCustomParam2, setPaymentCustomParam3, setPaymentCustomParam4, setPaymentMerchantId, setPaymentMerchantPassword, setPaymentMerchantUser, setPaymentSecureHash, setPaymentService, setStatus, setStorageService, setSubMaxAgeDataDelivered, setSubMaxAgeDataSaved, setSubmissionEncoding, setSupportsAmex, setSupportsDinersClub, setSupportsMasterCard, setSupportsVisa
Methods inherited from class com.avoka.core.entity.BaseEntity
appendProperties, getId, getValuesMap, isNew, setId, toString
Methods inherited from class org.apache.cayenne.CayenneDataObject
makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState
Methods inherited from class org.apache.cayenne.BaseDataObject
addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized
Methods inherited from class org.apache.cayenne.PersistentObject
getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.avoka.fc.core.entity.Auditable
getId, getValuesMap
Methods inherited from interface org.apache.cayenne.Persistent
getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState
-
Field Details
-
KEYSTORE_ROLLOVER_ANNUALLY
The 'Annually' keystore rollover policy.- See Also:
-
KEYSTORE_ROLLOVER_MONTHLY
The 'Monthly' keystore rollover policy.- See Also:
-
KEYSTORE_ROLLOVER_WEEKLY
The 'Weekly' keystore rollover policy.- See Also:
-
KEYSTORE_ROLLOVER_DAILY
The 'Daily' keystore rollover policy.- See Also:
-
KEYSTORE_ROLLOVER_POLICIES
The keystore rollover policies. -
TM_MONITOR_CLIENT_CODE
The TM Server Monitor client code.- See Also:
-
-
Constructor Details
-
Client
public Client()
-
-
Method Details
-
isActive
public boolean isActive()Return whether the client is active- Returns:
- true if the client is active
-
hasAccessToPortal
Return whether the client has access to the given portal- Parameters:
portal
- the portal (required)- Returns:
- true if the client has been assigned the given portal
-
getDefaultDeliveryDetails
Return the default delivery details for the client, or null if not defined.- Returns:
- the default delivery details for the client, or null if not defined
- Since:
- 4.0.0
-
getClientPortal
Return the client portal for the given portal.- Parameters:
portal
- the portal (required)- Returns:
- the client portal, or null if the client is not associated with the portal
- Since:
- 19.5.0
-
setJobAbandonmentBasedOnClient
Return the whether the job abandonment date is set based on associated client's job abandon age.- Parameters:
job
- the job (required)- Returns:
- true if the job's abandonment date is set based on the client's job abandon age.
- Since:
- 22.4.0
-