base_Root_Module_ItemDefinition_PropertyDefinition_sql_payment.md

@onzag/itemize / Modules / base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment

Module: base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment

Contains the sql and server side specific functions for the payment type

Table of contents

Functions

• paymentElastic
• paymentElasticSearch
• paymentSQL
• paymentSQLBtreeIndexable
• paymentSQLElasticIn
• paymentSQLEqual
• paymentSQLHiddenMetadataRow
• paymentSQLIn
• paymentSQLOut
• paymentSQLPreSideEffect
• paymentSQLSSCacheEqual
• paymentSQLSearch
• paymentSQLSelect
• paymentSQLSideEffect

Functions

paymentElastic

▸ paymentElastic(arg): Object

Parameters

Name	Type
arg	ISQLArgInfo

Returns

Object

Name	Type
properties	{}

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:42

---

paymentElasticSearch

▸ paymentElasticSearch(arg): Object

Searching for payment values

Parameters

Name	Type	Description
arg	IElasticSearchInfo	the argument search info

Returns

Object

a boolean on whether it's searched by it or not

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:320

---

paymentSQL

▸ paymentSQL(arg): Object

the sql function that setups the fields for the payment element

Parameters

Name	Type	Description
arg	ISQLArgInfo	the sql argumnent

Returns

Object

a partial row definition

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:30

---

paymentSQLBtreeIndexable

▸ paymentSQLBtreeIndexable(arg): string[]

The btree indexable used in searches

Parameters

Name	Type	Description
arg	ISQLBtreeIndexableInfo	the arg for the btree indexable options

Returns

string[]

the columns to index

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:474

---

paymentSQLElasticIn

▸ paymentSQLElasticIn(arg): Object

Parameters

Name	Type
arg	ISQLOutInfo

Returns

Object

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:236

---

paymentSQLEqual

▸ paymentSQLEqual(arg): void

How to consider equality with a value

Parameters

Name	Type	Description
arg	ISQLEqualInfo	the argument to check equality against

Returns

void

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:483

---

paymentSQLHiddenMetadataRow

▸ paymentSQLHiddenMetadataRow(prefix, id): string

The selection for the payment hidden metadata, only truly used by the provider

Parameters

Name	Type	Description
prefix	string
id	string	property id

Returns

string

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:97

---

paymentSQLIn

▸ paymentSQLIn(arg): Object

The sql in function for the payment

Parameters

Name	Type	Description
arg	ISQLInInfo	the sql in info argument

Returns

Object

a partial row

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:106

---

paymentSQLOut

▸ paymentSQLOut(arg): any

The sql out function

Parameters

Name	Type	Description
arg	ISQLOutInfo	the argument out info

Returns

any

a property definition supported payment type (or null)

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:195

---

paymentSQLPreSideEffect

▸ paymentSQLPreSideEffect(arg): "Setting up read only metadata is not allowed" | "Modifying read only metadata is not allowed"

Provides a side effect that triggers once a payment status changes, it's created, destroyed or comes into existance, this is the standard type server side effect that occurs when rq does things to it, and this will trigger what is necessary to it

Parameters

Name	Type
arg	ISQLSideEffectType<IPropertyDefinitionSupportedPaymentType>

Returns

"Setting up read only metadata is not allowed" | "Modifying read only metadata is not allowed"

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:600

---

paymentSQLSSCacheEqual

▸ paymentSQLSSCacheEqual(arg): boolean

How to check equality with a value using the cache

Parameters

Name	Type	Description
arg	ISQLSSCacheEqualInfo	the argument to check against

Returns

boolean

a boolean

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:498

---

paymentSQLSearch

▸ paymentSQLSearch(arg): boolean

Searching for payment values

Parameters

Name	Type	Description
arg	ISQLSearchInfo	the argument search info

Returns

boolean

a boolean on whether it's searched by it or not

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:252

---

paymentSQLSelect

▸ paymentSQLSelect(arg): string[]

The selection for the payment in searches

Parameters

Name	Type
arg	IArgInfo

Returns

string[]

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:80

---

paymentSQLSideEffect

▸ paymentSQLSideEffect(arg): void

Provides a side effect that triggers once a payment status changes, it's created, destroyed or comes into existance, this is the standard type server side effect that occurs when rq does things to it, and this will trigger what is necessary to it

Parameters

Name	Type
arg	ISQLSideEffectType<IPropertyDefinitionSupportedPaymentType>

Returns

void

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/payment.ts:511