This server class provides methods to operate with database records.
initialize()
This method creates an empty object for the new database record.
Return:
Type | Description |
---|---|
Void | This method does not return a value |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); incident.initialize(); incident.subject = "Network does not work"; incident.insert(); |
get(propertyOrValue, value)
Loads an object from a database based on the field value, or in a specific case by sys_id.
Parameter(s):
Name | Type |
---|---|
propertyOrValue | name (value must be specified as well). |
propertyOrValue | mixed |
value | mixed |
Return:
Type | Description |
---|---|
void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); incident.get( "subject" , "Network does not work" ) |
addQuery(property, operatorOrValue, value)
Описание: Добавляет условие для выборки из БД.
Принимает: property - string, operatorOrValue - оператор выбора (=, like, etc.) или значение - mixed. Опционально: value - mixed.
Возвращает: объект SimpleRecord, который выполняет обращение к методу.
Example:
Adding a condition for the selection from the database.
Parameter(s):
Name | Type |
---|---|
property | String |
operatorOrValue | Choice (=, Like), etc. |
operatorOrValue | Mixed |
value | Mixed |
Return:
Type | Description |
---|---|
SimpleRecord | An object that performs request to the method. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new |
SimpleRecord("incident"); |
incident.addQuery( "active", true ); incident.addQuery( "subject" , "LIKE" , "сеть" ); incident.addQuery( "sys_created_at" , "<" , "2019-04-01 00:00:00" ); |
incident.query(); |
query()
Runs a query against the selection from the database based on the $this→query. Fills in the record set.
Return:
Type | Description |
---|---|
Void | This method does not return a value |
Описание: Выполняет запрос по выборке из БД на основе $this->query. Заполняет набор записей.
Принимает: Ничего.
Возвращает: Ничего. |
next()
Описание: Возвращает следующую запись из спискаReturns next record from the list.
Принимает: Ничего.
Возвращает: Record | bool(если новый запрос то возвращает первую или false).
Example:
Return:
Type | Description |
---|---|
Record |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new |
SimpleRecord("incident"); |
incident.query(); |
while ( incident.next() ){ |
ss.info( incident.sys_id); |
} |
getValue(property)
Описание: Синоним для геттера.Принимает:string (поле, которое нужно вернуть).
Возвращает: mixed.
getClassDisplayValue(property)
Описание: Возвращает title таблицы. Если title не задан, возвращаетReturns the table title. If the title is not set, then returns name.
Return:
Type | Description |
---|---|
String | Title or name |
Принимает:Ничего.
Возвращает:string. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); |
ss.info( incident.getClassDisplayValue() ); |
getDisplayValue(property)
Описание: Возвращает отображаемое значение поля или записи(полеReturns a displayed field or record value ('display_by_ref
) (например, для reference поля вернется не ID, а имя сущности).' field).
For example, for the 'reference' field entity name will be returned, not an ID.
Parameter(s):
Name | Type |
---|---|
Property | String |
Return:
Type | Description |
---|---|
Mixed | A field or record value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new |
Принимает:string.
Возвращает:mixed.
Example:
let incident = newSimpleRecord("incident"); |
incident.get(5236); |
ss.info( incident.getDisplayValue( "caller_id" ) ); |
getLabel(property)
Описание: Возвращает заголовок поляReturns the field title.
Parameter(s):
Name | Type |
---|---|
property | String |
Return:
Type | Description |
---|---|
Mixed | The field title |
Принимает: string.
Возвращает: string. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); |
incident.get(5236); |
ss.info( incident.getLabel( "caller_id" ) ); |
next() | Описание: Возвращает следующую запись из списка. Принимает: Ничего. Возвращает: Record | bool(если новый запрос то возвращает первую или false). |
getValue(property) | Описание: Синоним для геттера. Принимает:string (поле, которое нужно вернуть). Возвращает: mixed. |
setValue(property, value) | Описание: Устанавливает значение поля в текущей записи. Принимает:property - string, value - mixed. Возвращает: Ничего. Example: let incident = new SimpleRecord('incident'); incident.setValue("subject" , "Help me"); incident.insert(); |
getTableName() | Описание: Возвращает имя текущей таблицы. Принимает:Ничего. Возвращает: string. let incident = new SimpleRecord('incident'); ss.info( incident.getTableName() ); // incident |
insert() | Описание: Создает запись в БД. Принимает:Ничего. Возвращает: integer (sys_id созданной записи). Example: let incident = new SimpleRecord('incident'); incident.insert(); |
update(reason) | Описание: Обновляет запись в БД. Принимает:string (причина обновления). Возвращает: integer (sys_id обновленной записи). Example: let incident = new SimpleRecord('incidnet'); incident.get(5246); incident.subject += " (repair)"; incident.update(); |
addEncodedQuery(condition) | Описание: Добавляет закодированный запрос к другим запросам, которые могли быть установлены. (не переносить, работает не верно, необходимо править) Принимает:string. Возвращает: Ничего. |
deleteRecord(recordSetId) | Описание: Удаляет текущую запись. Принимает:integer. Возвращает: bool. Example: let incident = new SimpleRecord('incident'); incident.get(5236); incident.deleteRecord(); |
deleteMultiple() | Описание: Удаляет несколько записей, которые удовлетворяют условию запроса. Этот метод не удаляет вложения. Не используйте deleteMultiple() для таблиц с зависимыми полями. Всегда удаляйте каждую запись отдельно. Кроме того, не используйте этот метод с методом setLimit() при работе с большими таблицами. Принимает: ничего. Возвращает: bool. Example: let incident = new SimpleRecord('incident'); incident.addQuery( 'subject' , "LIKE" , "network" ); incident.query(); incident.deleteMultiple(); |
getCurrentRecord() | Описание: Возвращает текущую запись. (не переносить, внутренний метод) Принимает:ничего. Возвращает: Record|false. |
orderBy(column) | Описание: Определяет столбец orderBy. Принимает: string. Возвращает: Ничего. Example: let incident = new SimpleRecord('incident'); incident.orderBy('subject'); incident.query(); |
orderByDesc(column) | Описание: Определяет нисходящий порядок по столбцу. Принимает: string. Возвращает: Ничего. Example: let incident = new SimpleRecord('incident'); incident.orderByDesc('subject'); incident.query(); |
setLimit(maxNumRecords) | Описание: Устанавливает ограничение на количество записей, извлекаемых по запросу SimpleRecord. Принимает: integer. Возвращает: Ничего. Example: let incident = new SimpleRecord('incident'); incident.setLimit(30); incident.query(); |
addOrCondition(property, operatorOrValue, value) | Описание: Добавляет условие OR параметра 2 или 3 к существующему запросу. Используется вместе с addQuery. Принимает: property - string, operatorOrValue - оператор выбора (=, like, etc.) или значение - mixed. Опционально: value - mixed. Возвращает:объект SimpleRecord, который выполняет обращение к методу. Example: let incident = new SimpleRecord('incident'); |
Method descrtiption
Parameter(s):
Name | Type |
---|---|
Return:
Type | Description |
---|---|
Example:
Code Block |
---|
Table of Contents |
---|