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
titleaddOrCondition
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.YN
operatorOrValueMixedYN
valueMixedNNULL


Return:

TypeDescription
SimpleRecordAn object performing the request to the method.


Example:

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

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
titlecanCreate
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
titlecanDelete
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
titlecanRead
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
titlecanUpdate
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
titledeleteMultiple
let incident = new SimpleRecord('incident');
incident.addQuery( 'subject' , "LIKE" , "network" );
incident.query();
incident.deleteMultiple();


deleteRecord(recordSetId)

Deletes This method deletes the current record.


Parameter(s):

NameTypeMandatoryDefault Value
recordSetIdIntegerN-1


Return:

TypeDescription
BooleanTrue if This method returns TRUE if the record is deleted successfully; otherwise it returns falseFALSE.


Example:

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


get(propertyOrValue, value)

Loads 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
titleget
let incident = new SimpleRecord("incident");
incident.get( "subject" , "Network does not work" )


getClassDisplayValue()

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


Return:

TypeDescription
StringTitle or name.


Example:

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


getDisplayValue(property)

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


Parameter(s):

NameTypeMandatoryDefault Value
PropertyStringNNULL


Return:

TypeDescription
MixedA field or record value.


Example:

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

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

getErrors()

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

Return:

TypeDescription
ArrayThe error value.


Example:

Code Block
languagejs
titlegetErrors
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)

Returns This method returns the field title.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
MixedThe field title.


Example:

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

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


getTableName()

Returns This method returns the current table name.


Return:

TypeDescription
StringThe current table name.


Example:

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

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


getValue(property)

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

Parameter(s):

NameTypeMandatoryDefault Value
PropertyStringYN


Return:

TypeDescription
MixedThe value of the field.


Code Block
languagejs
titlegetValue
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:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
titleinitialize
let incident = new SimpleRecord("incident");
incident.initialize();
incident.subject = "Network does not work";
incident.insert();

insert()

Creates This method creates a database record.


Return:

TypeDescription
IntegerThe Sys_id of the record created.


Example:

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

incident.insert();


next()

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


Return:

Type
Record or Boolean


Example:

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

incident.query();

while ( incident.next() ){

ss.info( incident.sys_id);

}


orderBy(column)

Specifies This method specifies an orderBy column.

Call this method several times to order by multiple columns.

Results The results are arranged in ascending order. To arrange the records in descending order, use the orderByDesc method.


Parameter(s):

NameTypeMandatoryDefault Value
columnStringColumn name.YN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

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


orderByDesc(column)

Sorts This method sorts the records in the descending order.


Parameter(s):

NameTypeMandatoryDefault Value
columnStringColumn name.YN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

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


query()

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


Return:

TypeDescription
VoidThis method does not return a value.


setAbortAction(flag)

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


Parameter(s):

NameTypeMandatoryDefault Value
flagBooleanYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
titlesetAbortAction
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
titlesetLimit
let incident = new SimpleRecord('incident');
incident.setLimit(30);
incident.query();


setValue(property, value)

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


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueMixedYN


Return:

TypeDescription
VoidThis property does not returns a value.


Example:

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

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

incident.insert();


update(reason)

Updates This method updates a database record.


Parameter(s):

NameTypeMandatoryDefault Value
reasonStringN''


Return:

TypeDescription
IntegerSys_id of the updated record.


Example:

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


Table of Contents
absoluteUrltrue
classfixedPosition