Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server class provides methods to operate with database records.
addOrCondition(property, operatorOrValue, value)
Appends a 2-or-3 parameter OR condition to an existing query. Works in conjunction with any of the addQuery() methods.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
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( 'contact_type' , 'email' ).addOrCondition( 'number' , 'INC0000006'); incident.query(); |
addQuery(property, operatorOrValue, value)
Adding a condition for the selection from the database.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
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(); |
canCreate()
Determines if the Access Control Rules permit inserting new records in this table.
Return:
Type | Description |
---|---|
Boolean | True if permitted; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); ss.info( incident.canCreate() ); |
canDelete()
Determines if the Access Control Rules permit deleting records in this table.
Return:
Type | Description |
---|---|
Boolean | True if permitted; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); ss.info( incident.canDelete() ); |
canRead()
Determines if the Access Control Rules permit reading records in this table.
Return:
Type | Description |
---|---|
Boolean | True if permitted; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); ss.info( incident.canRead() ); |
canUpdate()
Determines if the Access Control Rules permit updating records in this table.
Return:
Type | Description |
---|---|
Boolean | True if permitted; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); ss.info( incident.canUpdate() ); |
deleteMultiple()
This method allows to delete multiple records that meet the query condition.
It does not allow to delete attachments.
Do not use it on tables with dependencies. Always delete every record individually.
Also, do not use it combined with the setLimit() method when working with large tables.
Do not use deleteMultiple() on tables with currency fields. Always delete each record individually. Also, do not use this method with the chooseWindow() or setLimit() methods when working with large tables.
Return:
Type | Description |
---|---|
Boolean | True if deleted successfully; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.addQuery( 'subject' , "LIKE" , "network" ); incident.query(); incident.deleteMultiple(); |
deleteRecord(recordSetId)
Deletes the current record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
recordSetId | Integer |
Return:
Type | Description |
---|---|
Boolean | True if deleted successfully; otherwise returns false. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.get(5236); incident.deleteRecord(); |
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 | Mandatory | Default Value |
---|---|---|---|
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" ) |
getClassDisplayValue(property)
Returns the table title. If the title is not set, then returns name.
Return:
Type | Description |
---|---|
String | Title or name. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); ss.info( incident.getClassDisplayValue() ); |
getDisplayValue(property)
Returns a displayed field or record value ('display_by_ref' field).
For example, for the 'reference' field entity name will be returned, not an ID.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Property | String |
Return:
Type | Description |
---|---|
Mixed | A field or record value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); incident.get(5236); ss.info( incident.getDisplayValue( "caller_id" ) ); |
getLabel(property)
Returns the field title.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
property | String |
Return:
Type | Description |
---|---|
Mixed | The field title. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); incident.get(5236); ss.info( incident.getLabel( "caller_id" ) ); |
getTableName()
Returns the current table name.
Return:
Type | Description |
---|---|
String | The current table name. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); ss.info( incident.getTableName() ); // incident |
getValue(property)
Returns the value of the object property based on its name.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Property | String |
Return:
Type | Description |
---|---|
Mixed | The value of the field. |
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.query(); while( incident.next() ){ ss.info( incident.getValue('number') ); } |
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(); |
insert()
Creates a database record.
Return:
Type | Description |
---|---|
Integer | Sys_id of the record created. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.insert(); |
next()
If a new request, then returns the first record from the list; otherwise returns false, in case if the record is unavailable.
Return:
Type |
---|
Record or Boolean |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord("incident"); incident.query(); while ( incident.next() ){ ss.info( incident.sys_id); } |
orderBy(column)
Specifies an orderBy column.
Call this method several times to order by multiple columns.
Results are arranged in ascending order. To arrange the records in descending order use orderByDesc method.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
String | Column name. |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.orderBy('subject'); incident.query(); |
orderByDesc(column)
Sorts the records in the descending order.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
String | Column name. |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.orderByDesc('subject'); 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 | Mandatory | Default Value |
---|---|---|---|
Void | This method does not return a value. |
setAbortAction(flag)
Sets a flag indicating that will be current operation (insert/update/delete) interrupted. Used in business-rules.
Name | Type |
---|---|
flag | Boolean |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
current.setAbortAction(true); |
setLimit(maxNumRecords)
Sets a limit for a number of records are fetched by SimpleRecord query.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
maxNumRecords | Integer |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.setLimit(30); incident.query(); |
setValue(property, value)
Sets the value of the field in the current record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
property | String | ||
value | Mixed |
Return:
Type | Description |
---|---|
Void | This property does not returns a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incident'); incident.setValue("subject" , "Help me"); incident.insert(); |
update(reason)
Updates a database record
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
String | Reason of the update |
Return:
Type | Description |
---|---|
Integer | Sys_id of the updated record. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
let incident = new SimpleRecord('incidnet'); incident.get(5246); incident.subject += " (repair)"; incident.update(); |
Table of Contents | ||||
---|---|---|---|---|
|