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)


This method appends a 2-or-3 parameter OR condition to an existing query. It works in conjunction with any of the addQuery() methods.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
operatorOrValueChoice (=, Like), etc.YN
operatorOrValueMixedYN
valueMixedNNULL


Return:

TypeDescription
SimpleRecordAn object performing the request to the method.


Example:

Code Block
languagejs
themeEclipse
titleaddOrCondition
linenumberstrue
let incident = new SimpleRecord('incident');
incident.addQuery('contact_type', 'email').addOrCondition('number', 'INC0000006');
incident.query();


addQuery(property, operatorOrValue, value)


This method adds a condition for the selection from the database.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
operatorOrValueChoice (=, Like), etc.YNMixedNoperatorOrValueMixedYN
valueMixedNNULL


Return:

TypeDescription
SimpleRecordAn object performing the request to the method.


Example:

Code Block
languagejs
themeEclipse
titleaddQuery
linenumberstrue
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();


addEncodedQuery(condition)


Adds encoded query to other queries already created.


Parameter(s)

NameTypeMandatoryDefault Value
conditionStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddEncodedQuery
linenumberstrue
let incident = new SimpleRecord('incident');
incident.addEncodedQuery('active=1');


canCreate()


This method determines if the Access Control Rules permit inserting new records in this table.


Return:

TypeDescription
BooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlecanCreate
linenumberstrue
let incident = new SimpleRecord('incident');
ss.info( incident.canCreate() );

canDelete()


This method determines if the Access Control Rules permit deleting records in this table.


Return:

TypeDescription
BooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlecanDelete
linenumberstrue
let incident = new SimpleRecord('incident');
ss.info( incident.canDelete() );

canRead()


This method determines if the Access Control Rules permit reading records in this table.


Return:

TypeDescription
BooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlecanRead
linenumberstrue
let incident = new SimpleRecord('incident');
ss.info( incident.canRead() );


canUpdate()


This method determines if the Access Control Rules permit updating records in this table.


Return:

TypeDescription
BooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlecanUpdate
linenumberstrue
let incident = new SimpleRecord('incident');
ss.info( incident.canUpdate() );


deleteMultiple()


This method allows deleting multiple records that meet the query condition. It does not allow deleting attachments.

Do not use it on tables with dependencies. Always delete each record individually.

Also, do not use it combined with the setLimit() method when working with large tables.

Do not use the deleteMultiple() method on the tables with the 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:

TypeDescription
BooleanThis method returns TRUE  if deleted successfully; otherwise returns false.


Example:

Code Block
languagejs
themeEclipse
titledeleteMultiple
linenumberstrue
let incident = new SimpleRecord('incident');
incident.addQuery( 'subject' , "LIKE" , "network" );
incident.query();
incident.deleteMultiple();


deleteRecord(recordSetId)


This method deletes the current record.


Parameter(s):

NameTypeMandatoryDefault Value
recordSetIdIntegerN-1


Return:

TypeDescription
BooleanThis method returns TRUE if the record is deleted successfully; otherwise it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titledeleteRecord
linenumberstrue
let incident = new SimpleRecord('incident');
incident.get(5236);
incident.deleteRecord();


get(propertyOrValue, value)


This method loads an object from a database based on the field value, or, in a specific case, by the sys_id.


Parameter(s):

NameTypeMandatoryDefault Value
propertyOrValuename (value must be specified as well).YN
propertyOrValuemixedYN
valuemixedNNULL


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleget
linenumberstrue
let incident = new SimpleRecord("incident");
incident.get( "subject" , "Network does not work" )


getAttributes()

This method returns an object with current record properties as keys and properties values as key values.


Return:

TypeDescription
ObjectThe array containing attributes.


Code Block
languagejs
themeEclipse
titlegetAttributes
linenumberstrue
const rec = new SimpleRecord('sys_db_table');
rec.get(some_id);
const attrs = rec.getAttributes();
// attrs = {sys_id: some_id, title: "My title", name: "my_name", ...}

getClassDisplayValue()


This method returns the table title. If the title is not set, then returns name.


Return:

TypeDescription
StringTitle or name.


Example:

Code Block
languagejs
themeEclipse
titlegetClassDisplayValue
linenumberstrue
let incident = new SimpleRecord("incident");
ss.info( incident.getClassDisplayValue() );


getDisplayValue(property)


This method returns displayed field or record value (the display_by_ref field). For example, for the reference field the entity name will be returned, but not the ID.


Parameter(s):

NameTypeMandatoryDefault Value
PropertyStringNNULL


Return:

TypeDescription
MixedA field or record value.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValue
linenumberstrue
let incident = new SimpleRecord("incident");

incident.get(5236);
ss.info( incident.getDisplayValue( "caller_id" ) );

getErrors()


If the record creating, updating or deleting will fail, then this method will display error message.

Return:

TypeDescription
ArrayThe error value.


Example:

Code Block
languagejs
themeEclipse
titlegetErrors
linenumberstrue
let rec = new SimpleRecord('sys_db_table');
rec.get('name', 'task');
if (!rec.deleteRecord()) {
	let errors = rec.getErrors();
 	errors.forEach(function(error) {
		ss.addErrorMessage(error);
	})
}


getLabel(property)


This method returns the field title.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
MixedThe field title.


Example:

Code Block
languagejs
themeEclipse
titlegetLabel
linenumberstrue
let incident = new SimpleRecord("incident");

incident.get(5236);
ss.info( incident.getLabel( "caller_id" ) );


getTableName()


This method returns the current table name.


Return:

TypeDescription
StringThe current table name.


Example:

Code Block
languagejs
themeEclipse
titlegetTableName
linenumberstrue
let incident = new SimpleRecord('incident');

ss.info( incident.getTableName() ); // incident


getValue(property)


This method returns the value of the object property based on its name.

Parameter(s):

NameTypeMandatoryDefault Value
PropertyStringYN


Return:

TypeDescription
Mixed

The value of the field.

Tip

The value from the database will be returned for the reference fields.



Code Block
languagejs
themeEclipse
titlegetValue
linenumberstrue
const record = new SimpleRecord('task');
record.get('15000000000001');
ss.info(record.getValue('assigned_user')); // 150000000534521234


insert()


This method creates a database record.


Return:

TypeDescription
IntegerThe Sys_id of the record created.


Example:

Code Block
languagejs
themeEclipse
titleinsert
linenumberstrue
let incident = new SimpleRecord('incident');

incident.insert();

matchesCondition(condition)

This method checks whether the current record meets the condition being in the current state.


NameTypeMandatoryDefault Value
conditionStringN''


TypeDescription
VoidThis method does not return a value.


Code Block
languagejs
themeEclipse
titlematchesCondition
linenumberstrue
rec.description = 'dsc';
rec.matchesCondition('descriptionLIKEesc'); // false
rec.description = 'desc';
rec.matchesCondition('descriptionLIKEesc'); // true


next()


If this is a new request, then this method returns the first record from the list; otherwise it returns FALSE, in the case if the record is unavailable.


Return:

Type
Record or Boolean


Example:

Code Block
languagejs
themeEclipse
titlenext
linenumberstrue
let incident = new SimpleRecord("incident");

incident.query();

while ( incident.next() ){

ss.info( incident.sys_id);

}


orderBy(column)


This method sorts records in the ascending order.


Tip

Call this method several times to order by multiple columns.


Parameter(s):

NameTypeMandatoryDefault Value
columnStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleorderBy
linenumberstrue
let incident = new SimpleRecord('incident');
incident.orderBy('subject');
incident.query();


orderByDesc(column)


This method sorts the records in the descending order.


Parameter(s):

NameTypeMandatoryDefault Value
columnStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleorderByDesc
linenumberstrue
let incident = new SimpleRecord('incident');
incident.orderByDesc('subject');
incident.query();


query()


This method runs a query against the selection from the database, based on the $this→query. After this, it fills in the record set.


Return:

TypeDescription
VoidThis method does not return a value.


selectAttributes(attributes)


This method is intended to optimize database queries. Sometimes, it is necessary to obtain only several object fields, not the whole object, Therefore, this method is added.


NameTypeMandatoryDefault Value
attributesString or ArrayYN

Return:

TypeDescription
SimpleRecord objectThis method returns a SimpleRecord object containing attributes.

Example:

Code Block
languagejs
themeEclipse
titleselectAttributes
linenumberstrue
const record = new SimpleRecord('user');
record.selectAttributes(['email']);
record.query();
while (record.next()) {
    ss.info(record.email); // not null
    ss.info(record.first_name); // null
    ss.info(record.username); // null
    ... // other fields are null
}


setAbortAction(flag)


This method sets a flag, indicating that will be current operation (insert/update/delete) interrupted. It used in business-rules.


Parameter(s):

NameTypeMandatoryDefault Value
flagBooleanYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetAbortAction
linenumberstrue
current.setAbortAction(true);

setLimit(maxNumRecords)


Sets a limit for a number of records are fetched by SimpleRecord query.


Parameter(s):

NameTypeMandatoryDefault Value
maxNumRecordsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetLimit
linenumberstrue
let incident = new SimpleRecord('incident');
incident.setLimit(30);
incident.query();


setMultipleValue(property,value)

This method sets the properties values for every entry in the current selection.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueMixedYN

Return:

TypeDescription
Void

This method does not return a value.


Code Block
languagejs
themeEclipse
titlesetMultipleValue
linenumberstrue
const rec = new SimpleRecord('task');
rec.addQuery('state', 'Created');
rec.query();
rec.setMultipleValue('state', 'Confirmed');
rec.updateMultiple();

setValue(property, value)


This method sets the value of the field in the current record.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueMixedYN


Return:

TypeDescription
VoidThis property does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetValue
linenumberstrue
let incident = new SimpleRecord('incident');

incident.setValue("subject" , "Help me");

incident.insert();


silentMode(enable)

This method is intended to update the record without executing any entities related to this record implementing the business logic, such as business rules, notifications, workflows, etc.


NameTypeMandatoryDefault Value
enableBooleanYN


TypeDescription
VoidThis property does not return a value.


Code Block
languagejs
themeEclipse
titlesilentMode
linenumberstrue
let record = new SimpleRecord('task');
record.query();
record.next();
record.silentMode();
record.update();



update(reason)


This method updates a database record.


Parameter(s):

NameTypeMandatoryDefault Value
reasonStringN''


Return:

TypeDescription
IntegerSys_id of the updated record.


Example:

Code Block
languagejs
themeEclipse
titleupdate
linenumberstrue
let incident = new SimpleRecord('incident');
incident.get(5246);
incident.subject += " (repair)";
incident.update();


updateMultiple()

This method updates all the selection entries.

Return:

TypeDescription
VoidThis property does not returns a value.


Code Block
languagejs
themeEclipse
titleupdateMultiple
linenumberstrue
const rec = new SimpleRecord('task');
rec.addQuery('state', 'Created');
rec.query();
rec.setMultipleValue('state', 'Confirmed');
rec.updateMultiple();


Table of Contents
absoluteUrltrue
classfixedPosition