Skip to main content

%DeepSee.Model.ListingGroup.listing

Class %DeepSee.Model.ListingGroup.listing Extends %DeepSee.Model.ListingGroup.node [ System = 3 ]

Meta-data object that represents a listing for a DeepSee SubjectArea.

Properties​

listingGroup​

Relationship listingGroup As %DeepSee.Model.ListingGroup.listingGroup(XMLPROJECTION = "none") [ Cardinality = one, Inverse = listings ];

Listing Group that this listing belongs to.

listingType​

Property listingType As %String(MAXLEN = 50, VALUELIST = ",table,map", XMLPROJECTION = "attribute") [ InitialExpression = "table" ];

Indicates how to display this listing.
"table" (the default) shows the listing as a table.
"map" shows the listing within a map view. For this case, your listing must contain a columns called "Latitude" and "Longitude".

fieldList​

Property fieldList As %String(MAXLEN = "", XMLPROJECTION = "attribute");

Optional. If specified, this is used as the RETURN clause for the DRILLTHROUGH query used for this listing.

formatList​

Property formatList As %String(MAXLEN = 5000, XMLPROJECTION = "attribute");

Optional. This is a "^" delimited list of css formatting instructions for the listing. Each piece of the list is applied to its corresponding column in the listing.

orderBy​

Property orderBy As %String(MAXLEN = 1000, XMLPROJECTION = "attribute");

Optional. If specified, this is used as the %ORDER BY clause for the DRILLTHROUGH query used for this listing.

sql​

Property sql As %String(MAXLEN = "", XMLPROJECTION = "attribute");

Optional. If specified, this is the sql statement used for this listing.

sourceClass​

Property sourceClass As %DeepSee.Datatype.className(XMLPROJECTION = "attribute");

Name of the %DeepSee.DataConnector class that provides the listing data.
If the cube uses a data connector as its sourceClass, then you must specify this value if you wish to show listings for the cube.

resource​

Property resource As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Optional. The resource needed to view this listing:
If defined and the current user holds the USE privilege on this resource, then the user may view this listing.

selectMode​

Property selectMode As %String(DISPLAYLIST = ",Logical,ODBC,Display", VALUELIST = ",0,1,2", XMLPROJECTION = "attribute") [ InitialExpression = 2 ];

SQL selectMode which this SQL listing will use to execute.
Possible values are:

  • 0 for LOGICAL mode.
  • 1 for ODBC mode.
  • 2 for DISPLAY mode.

Methods​

%Validate​

Method %Validate() As %Status

Test if this listing's definition is valid.