IRISLIB database
ListingGroup Class Reference

This class contains APIs for managing Listing Groups. More...

Inheritance diagram for ListingGroup:
Collaboration diagram for ListingGroup:

Static Private Member Functions

_.Library.String GetClassName (pListingGroupName, pCompiled)
 This class contains APIs for managing Listing Groups. More...
 
 GetListingGroups (pList, pCompiled, pRequestCube)
 Returns a list of listing groups currently stored. More...
 
_.Library.Status SaveListingGroup (_.DeepSee.Model.ListingGroup.listingGroup pGroupObject, pClassName)
 Utility method for saving a listing group object to its class.
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This class contains APIs for managing Listing Groups.

A listing group porvides the ability to define DeepSee listings outside of the cube and subject area definitions.

Member Function Documentation

◆ GetClassName()

_.Library.String GetClassName (   pListingGroupName,
  pCompiled 
)
staticprivate

This class contains APIs for managing Listing Groups.

A listing group porvides the ability to define DeepSee listings outside of the cube and subject area definitions.

Look up the storage class for a given listing group. The parameter

pCompiled = 1 indicates only the available metadata should be returned. pCompiled = 0 returns all listing definition classes defined in the namespace.

◆ GetListingGroups()

GetListingGroups (   pList,
  pCompiled,
  pRequestCube 
)
staticprivate

Returns a list of listing groups currently stored.

The return structure is

pList(GroupID,counter) = $LB(GroupID,Name,Caption,CubeList,Class). If the setting pCompiled = 1 is used, only listing groups that have successfully been compiled will be returned. Otherwise, all models currently saved will be returned.