new nlobjSearchColumn(name, join, summary) → {nlobjSearchColumn}
Return a new instance of nlobjSearchColumn used for column objects used to define search return columns.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | column name. |
join |
string | internal ID for joined search where this column is defined |
summary |
string |
- Since:
- 2007.0
- Source:
- nlapihandler_stubs.js, line 2419
Returns:
- Type
- nlobjSearchColumn
Methods
-
getFormula() → {string}
-
return formula for this search column.
- Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 2471
Returns:
- Type
- string
-
getJoin() → {string}
-
return the join id for this search column.
- Since:
- 2008.1
- Source:
- nlapihandler_stubs.js, line 2439
Returns:
- Type
- string
-
getLabel() → {string}
-
return the label of this search column.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2450
Returns:
- Type
- string
-
getName() → {string}
-
return the name of this search column.
- Since:
- 2008.1
- Source:
- nlapihandler_stubs.js, line 2429
Returns:
- Type
- string
-
getSummary() → {string}
-
return the summary type (avg,group,sum,count) of this search column.
- Since:
- 2008.1
- Source:
- nlapihandler_stubs.js, line 2460
Returns:
- Type
- string
-
setSort(sort) → {nlobjSearchColumn}
-
return nlobjSearchColumn sorted in either ascending or descending order.
Parameters:
Name Type Description sort
boolean if not set, defaults to false, which returns column data in ascending order. - Since:
- 2010.1
- Source:
- nlapihandler_stubs.js, line 2483
Returns:
- Type
- nlobjSearchColumn