GlideListV3 (g_list) - Client (deprecated)

The GlideListV3 API provides methods to manipulate lists.

You access the GlideListV3 methods by using the g_list global object. These methods are used in UI context menus and UI actions. The g_list object is not available for related lists on the form link UI action.

Note:

This API is no longer supported. Consider using the GlideList2() API instead.

Parent Topic:Client API reference

GlideListV3 - addFilter(String filter)

Adds a single term to the list query filter.

GlideListV3 - get(String listId)

Returns the GlideList object for specified list.

GlideListV3 - get(Object DomElement)

Returns the GlideList object for the specified DOM element.

GlideListV3 - getChecked()

Returns a comma-separated list of sys_ids for checked items in the list. Does not return items that are not allowed to be executed.

GlideListV3 - getFixedQuery()

Returns the sysparm_fixed query.

The fixed query is the part of the query that cannot be removed from the breadcrumb (i.e., it is fixed for the user). It is specified by including a sysparm_fixed_query parameter for the application module.

GlideListV3 - getFormTarget()

Returns the form's target attribute.

GlideListV3 - getGroupBy()

Returns the field or comma-separated list of fields that are used to group the list.

GlideListV3 - getListName()

Returns the name of the list, which is usually the table name.

GlideListV3 - getOrderBy()

Returns the first field used to order the list.

GlideListV3 - getParentTable()

Returns the name of the parent table (the table associated with the form).

GlideListV3 - getQuery(Object options)

Returns the encoded query string for the list.

GlideListV3 - getReferringUrl()

Returns the referring URL.

GlideListV3 - getRelated()

Returns the related list field that associates the related list to the parent form.

GlideListV3 - getRelatedListType()

Returns the related list type.

GlideListV3 - getRelationshipId()

Returns the relationship record id, if this is type REL related list.

GlideListV3 - getRowCount()

Returns the number of rows returned by the query.

GlideListV3 - getRowsPerPage()

Returns the number of rows to be displayed on a page.

GlideListV3 - getTableName()

Returns the table name of the list.

GlideListV3 - getTitle()

Returns the list title.

GlideListV3 - getView()

Returns the view used to display the list.

GlideListV3 - isUserList()

Returns true if the list has been personalized by the user.

GlideListV3 - refresh(Number firstRow, Object additionalParams)

Refreshes the list. The orderBy part of the list filter is ignored so that the list's natural ordering is used.

GlideListV3 - refreshWithOrderBy(Number firstRow, Object additionalParams)

Refreshes the list using the orderBy fields.

GlideListV3 - setFilter(String filter, Boolean saveOrderBy, Boolean saveGroupBy)

Sets the encoded query string for the list ignoring the orderBy and groupBy parts of the query string.

GlideListV3 - setFilterAndRefresh( String filter)

Sets the encoded query string for the list, and then refreshes the list using the new filter.

This preserves the groupby and orderby parameters.

GlideListV3 - setFirstRow(Number firstRow)

Sets the first row to be displayed when the list is refreshed.

GlideListV3 - setFormTarget(String target)

Specifies where to display the response from the form.

GlideListV3 - setGroupBy(String groupBy)

Sets the groupBy criteria for the list, for a single field or multiple fields.

For a single field, use field or groupByField. The groupBy prefix is optional. For multiple fields use field1^field2^field3 or groupByField1^groupByField2^groupByField3.

GlideListV3 - setOrderBy(String orderBy)

Sets the orderBy criteria for the list.

For a single order by field use orderBy field or orderByDescField. For multiple fields, use orderByField1^orderByField2^orderByField3. orderBy specifies ascending order and orderByDesc specifies descending. These prefix strings are optional. If not specified orderBy is assumed.

GlideListV3 - setReferringUrl(String url)

Sets the parent form referring url.

GlideListV3 - setRowsPerPage(Number numRows)

Set the number of rows to display on a page.

GlideListV3 - showHideGroups(Boolean showFlag)

Displays or hides all of the groups within the list and saves the current collapsed/expanded state of the groups as a user preference.

GlideListV3 - showHideList(Boolean showFlag)

Displays or hides the list and saves the current collapsed/expanded state of the list as a user preference.

GlideListV3 - sort(String field)

Sort the list in ascending order.

GlideListV3 - sortDescending(String field)

Sorts the list in descending order.

GlideListV3 - toggleList()

Toggles the list display between collapsed and expanded, and saves the state as a user preference.

GlideListV3 - toggleListNoPref()

Toggles the list display between collapsed and expanded, but does not save the state as a user preference.