IdentifiableObject

IdentifiableObject

Represents Identifiable Object

Constructor

new IdentifiableObject(objectName)

Source:

Creates a identifiable object fetcher

Parameters:
Name Type Description
objectName string

The name of the identifiable object as used in the web api

Extends

Members

name

Source:

Gets the name of the identifiable object

url

Source:
Overrides:

Gets the url for fetching

Methods

get() → {ProgressPromise}

Source:
Inherited From:

Gets the running process started

Returns:
Type
ProgressPromise

getDependecyFetchResults() → {ProgressPromise}

Source:
Inherited From:

Get Dependency results

Returns:
Type
ProgressPromise

setParameters(parameters) → {Fetcher}

Source:
Inherited From:

Set paremeters

Parameters:
Name Type Description
parameters Object

The parameters to be passed to the url
Returns:
  • Object of the fetcher
Type
Fetcher

where(right, operator, left) → {IdentifiableObject}

Source:

Sets the where clause for filtering of data

Example
const organisationUnit = new Fn.IdentifiableObject('organisationUnits');
organisationUnit.where('level','==',4); //Will set to fetch organisation units at level 4
organisationUnit.where('children','empty'); //Will set to fetch organisation units with no children
Parameters:
Name Type Description
right string

Right expression
operator string

Expression operator
left string | array

Right expression
Returns:

IdentifiableObject Identifiable object with where clause appended

Type
IdentifiableObject