ActiveStatus Property

Limits the search to active or inactive records only.

Syntax

 objsearch.getActiveStatus([callback])
 objsearch.setActiveStatus( activeStatus, [callback])

Possible Values

  0 (asUnspecified), 
  1 (asActiveOnly), 
  2 (asInactiveOnly), 
  3 (asAll)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getActiveStatus([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setActiveStatus([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Limits the search to active or inactive records only. May be used to limit the search to active or inactive records only.

The following values are permitted:

Only applicable to searches for entity objects.

Data Type

Integer