ctrlCommList (controller in module tri )

Methods

• dropRecord(oaa)

  This removes Data Object from the Table. The Data Object to remove is obtained using `oaa'

  This call is forwarded to servCRUD.dropRecord. Refer there for more details.

  Parameters

  • oaa – {Object} –

    The Object Access Address. A string or number determining the required record. See Record Storage for a description of oaa.

• editRecord(oaa)

  This puts the system into 'Edit' mode and activates the system Edit Controller using the Data Object obtained using `oaa'

  This call is forwarded to servCRUD.editRecord. Refer there for more details.

  Parameters

  • oaa – {Object} –

    The Object Access Address. A string or number determining the required record. See Record Storage for a description of oaa.

• getColClass(ix, oCol)

  Used to provide a series of class types 'C1', 'C2', ... 'Cn' based on whether a column is shown in the list.

  This value is typically used with ng-class and then referenced in the .CSS style sheets.

  This provides a convenient way to format HTML table columns (<TD>) and their header (<TH>).

  Parameters

  • ix – {number} –

    index of column

  • oCol – {Object} –

    dynamic Col object

• getColTitle(oFil)

  Returns a column title suitable for display

  Returns null if oFil.field is null of undefined

  Returns oCol.getTitle() if Col object oCol exists in the current context

  Else returns `oFil.field'

  Parameters

  • oFil – {Object} –

    Filter object

  Returns

  {string} –

  computed value

• getFilter(oSel, sFld)

  Returns a Filter object whose type matches 'state' found in oSel and whose field value matches sFld. Refer also to servSess.useTable.

  Parameters

  • oSel – {Object} –

    object managed with servSess.useTable

  • sFld – {string} –

    Filter name to extract

  Returns

  {Object} –

  Filter object

• getFilters(oSel, sType)

  Returns an array of Filter objects that match sType found in oSel. Refer to servSess.useTable.

  The returned value is cached as this function is called many times.

  Parameters

  • oSel – {Object} –

    object managed with servSess.useTable

  • sType – {string} –

    Filter type

  Returns

  {Object[]} –

  Filter objects that match sType

• getObjs()

  Returns the Data Object collection for the specified Table.

  This call is forwarded to servCRUD.getObjs and returns the value obtained thereby.

  Returns

  {Object[]} –

  Data Object collection for the specified Table

• getRefColOpt(oFil)

  Typically used to populate a 'select' control with values from a related Table that is updated dynamically based on the values stored in that Table.

  Returns an empty list if oFil.type != 'state' or Col object for oFil.field is not located

  Returns an empty list if oCol.oneOf is not defined

  Else returns the servREC.getOptions return value

  Parameters

  • oFil – {Object} –

    Filter object

  Returns

  {Object[]} –

  A collection of options returned by servREC.getOptions

• getTabProp()

  This returns the properties props object of current dynamic dynamic Table object.

  This call is forwarded to servCRUD.getTabProp and returns the value obtained thereby.

  Returns

  {Object} –

  Properties object of current (oTAB) object. oTAB is set to null.

• getTableCols(type)

  Returns a collection of Col objects that match type.

  This call is forwarded to servREC.getTableCols with the insertion of the $scope variable and returns the value obtained thereby.

  Parameters

  • type – {string} –

    The type of column array to extract. eg '=list', '=edit'

  Returns

  {Object[]} –

  the value returned by servREC.getTableCols

• hasSession()

  Returns whether a valid session exists. ie. The User is properly logged in and validated.

  This call is forwarded to servSess.hasSession and returns the value obtained thereby.

  Returns

  {Boolean} –

  the value returned by servSess.hasSession

• inDlgEdit()

  Returns whether the system Edit Controller is active and in Dialog mode.

  This call is forwarded to servCRUD.inDlgEdit and and returns the value obtained thereby.

  Returns

  {Boolean} –

  true if Edit Controller is active and in Dialog mode

• inEdit()

  Returns whether the system Edit Controller is active.

  This call is forwarded to servCRUD.inEdit and and returns the value obtained thereby.

  Returns

  {Boolean} –

  true if Edit Controller is active

• initFilter(oFil)

  Moves the Filter object to the $scope.oSel object if $scope.oSel object does not contain oFil.name

  Parameters

  • oFil – {Object} –

    Filter object

• isSect(sect)

  Returns whether sect section matches the current section.

  This call is forwarded to servSess.isSect and returns the value obtained thereby.

  Parameters

  • sect – {string} –

    value to match against

  Returns

  {Boolean} –

  the value returned by servSess.isSect

• makeRecord()

  This puts the system into 'Create' mode and activates the system Edit Controller.

  This call is forwarded to servCRUD.makeRecord. Refer there for more details.

• showCol(oCol)

  This call is forwarded to servREC.showListCol and the {Boolean} result returned as a {string}.

  Parameters

  • oCol – {Object} –

    Col object to test

  Returns

  {string} –

  'true' if column should be shown else 'false'

• useTable(table, sel)

  This sets a new Table context for the List Controller.

  This call is forwarded to servSess.useTable with the insertion of the $scope variable and returns the value obtained thereby.

  Parameters

  • table – {Object} –

    table name (title) to find

  • sel – {string} –

    previous/default selection (filter) context

  Returns

  {Boolean} –

  the value returned by servSess.useTable