IDataAdminCollection methods

Defines the methods listed in the following table.

Table 1. Multi-tenant Maintenance IDataAdminCollection interface methods
Method syntax Description 
IIterator Iterator ( filter AS CHARACTER )
Returns a filtered and/or sorted iterator (IIterator) object that provides the selected entities from the collection, where filter is a query expression on the properties of the entities in the collection. Property expressions and their constituent elements (including operators) must be separated by space, and values must be quoted.

For more information on filtering and sorting entities from a collection, see Filtering and sorting. For more information on the returned IIterator object, see IIterator interface.

 
VOID Export ( )
 Exports the entity collection data to a JSON file named for the sub-interface entity collection, for instance, areaset.json or tenantset.json for an IAreaSet or ITenantSet object, respectively. 1 
VOID Export ( cFilename AS CHARACTER )
 Export entity data in the collection to the file specified by cFilename.1 
VOID ExportLastSaved ( cFilename AS CHARACTER )
 Export entity data in the collection to the file specified by cFilename.1

Use only after calling Import( ) and the related Create*( ) or Update*( ) service method.

 
VOID ExportLastSavedTree (
  cFilename AS CHARACTER )
 Export entity data in the collection with all child collections to the file specified by cFilename.1

Use only after calling Import( ) and the related Create*( ) or Update*( ) service method.

 
VOID ExportTree ( cFilename AS CHARACTER )
 Export entity data in the collection with all child collections to the file specified by cFilename.1 
VOID ExportTree ( 
  cFilename AS CHARACTER ,
  pcCollections AS CHARACTER )
 Export entity data in the collection with specified child collections to the file specified by cFilename.1

Child collections are specified in pcCollections as a comma-separated list of entity names, for instance, "Domains,TenantGroups", depending on the collection.

 
VOID Import ( cFilename AS CHARACTER )
 Import entity data to the collection from the file specified by cFilename. (The file must exist.)1 
VOID ImportTree ( cFilename AS CHARACTER )
 Import entity data to the collection, including child collections, from file specified by cFilename. (The top-level entity must exist.)1

See also:

1 Currently supports JSON (.json) files only.