DocDBs Class Reference

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. More...

Inheritance diagram for DocDBs:

Collaboration diagram for DocDBs:

Static Public Member Functions
_.Library.Status	Create (_.Library.String Name, _.Library.String Namespace, _.Library.String Properties)
	Create a Doc DB. More...
_.Library.Status	Delete (_.Library.String Name, _.Library.String Namespace)
	Delete a Doc DB. More...
_.Library.Boolean	Exists (_.Library.String Name, _.Library.String Namespace, _.Library.ObjectHandle DocDB, _.Library.Status Status)
	Doc DB exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String Names, _.Library.String Namespaces)
	This method exports Doc DB records to a file in xml format. More...
_.Library.Status	Get (_.Library.String Name, _.Library.String Namespace, _.Library.String Properties)
	Get a Doc DBs properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import Doc DB records from an xml file. More...
_.Library.Status	Modify (_.Library.String Name, _.Library.String Namespace, _.Library.String Properties)
	Modify a Doc DBs properties. More...

Public Attributes
	Description
	Description of the Doc DB. More...
	Enabled
	Doc DB enabled. More...
	Name
	Name of the Doc DB. More...
	Namespace
	More...
	Resource
	More...

Detailed Description

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal.

It should not be updated through direct SQL access.

Member Function Documentation

Create()

_.Library.Status Create ( _.Library.String  Name, _.Library.String  Namespace, _.Library.String  Properties  )

static

Create a Doc DB.

Create a Doc DB in the Security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of location of the Doc DB Description - Description of the Doc DB
Enabled - Enabled for auditing - 0/1
Resource - Resource controlling the Doc DB.

Delete()

_.Library.Status Delete ( _.Library.String  Name, _.Library.String  Namespace  )

static

Delete a Doc DB.

This method will delete an Doc DB from the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the DOC DB
This method also clears the in memory counters.

Exists()

_.Library.Boolean Exists ( _.Library.String  Name, _.Library.String  Namespace, _.Library.ObjectHandle  DocDB, _.Library.Status  Status  )

static

Doc DB exists.

This method checks for the existence of a Doc DB in the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the Doc DB Return values:
If Value of the method = 0 (Doc DB does not exist, or some error occured)
DocDB = Null
Status = Doc DB "x" does not exist, or other error message<br>
If Value of the method = 1 (Doc DB exists)
Doc DB = Object handle to Doc DB
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  Names, _.Library.String  Namespaces  )

static

This method exports Doc DB records to a file in xml format.

Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
Names - Comma separated list of Doc DBs to export, "*" = All
Namespaces - Comma separated list of Namespaces to export, "*" = All

Get()

_.Library.Status Get ( _.Library.String  Name, _.Library.String  Namespace, _.Library.String  Properties  )

static

Get a Doc DBs properties.

Gets a Doc DBs properties from the security database.
Parameters:
Name - Name of the Doc DB
namespace - Namespace of the Doc DB
Return values:
Properties - Array of properties
"Description" - Description of the Doc DB
"Enabled" - Doc DB is enabled
"Resource" - Resource of the Doc DB

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

Import Doc DB records from an xml file.

Parameters:
FileName - Filename to import Doc DB records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

Modify()

_.Library.Status Modify ( _.Library.String  Name, _.Library.String  Namespace, _.Library.String  Properties  )

static

Modify a Doc DBs properties.

Modifies a Doc DBs properties from the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the Doc DB
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Member Data Documentation

Description

Description

Description of the Doc DB.

 

Enabled

Enabled

Doc DB enabled.

 

Name

Name

Name of the Doc DB.

 

Namespace

Namespace

 

 

Resource

Resource