GenericMapMethods Class Reference

This class contains methods which are common (inherited) by classes which manipulate namespace mappings in the CPF file. More...

Inheritance diagram for GenericMapMethods:

Collaboration diagram for GenericMapMethods:

Static Public Member Functions
_.Library.Status	Delete (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Delete a mapping from a CPF file. More...
_.Library.Boolean	Exists (ID, _.Library.String Name, _.Library.ObjectHandle Obj, _.Library.Status Status, _.Library.String CPFFile, _.Library.Integer Flags)
	Checks for the existence of a mapping in a CPF file. More...
_.Library.Status	Get (_.Library.String ID, _.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Get a mapping's properties from a CPF file. More...
_.Library.Status	GetList (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Returns the properties from a instance of a mapping section from a CPF file by value in $list format More...
_.Library.Status	Modify (_.Library.String ID, _.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Modify a mapping in a CPF file. More...
_.Library.ObjectHandle	Open (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer concurrency, _.Library.Status Status, _.Library.Integer Flags)
	Open an instance of a mapping object in a CPF file. More...

Static Public Attributes
	CAPITALNAME = None
	Determines if the Name specified in the index should be capitalized. More...
	SECTIONTYPE = None
	This parameter governs how the class creates audit records. More...

Detailed Description

This class contains methods which are common (inherited) by classes which manipulate namespace mappings in the CPF file.

Member Function Documentation

Delete()

_.Library.Status Delete ( _.Library.String  ID, _.Library.String  Name, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Delete a mapping from a CPF file.

Parameters:
Namespace - Namespace to delete the mapping from.
Name - Name of the mapping to delete.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform. See the <METHOD>Create</METHOD> method for values.

Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.

Exists()

_.Library.Boolean Exists (   ID, _.Library.String  Name, _.Library.ObjectHandle  Obj, _.Library.Status  Status, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Checks for the existence of a mapping in a CPF file.

Parameters:
Namespace - Namespace of the mapping.
Name - Name of the mapping to check existence of.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform if the object is later saved with the Save() method. See the <METHOD>Create</METHOD> method for values.

Return values:
If Value of the method = 0 (Mapping does not exist, or some error occured)
Obj = Null
Status = Mapping "x" does not exist, or other error message<br>
If Value of the method = 1 (Mapping exists)
Obj = Object handle to Mapping
CPFFile = Name of the CPF file the properties were retrieved from.
Status = MapGlobal "x" already exists

Get()

_.Library.Status Get ( _.Library.String  ID, _.Library.String  Name, _.Library.String  Properties, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Get a mapping's properties from a CPF file.

Parameters:
ID - ID of the mapping.
Name - Name of the instance within the mapping to retrieve.
CPFFile - Name of the CPF file to use, Default=current active CPF file.

Return values:
Properties (byref) - List of the properties in Properties(Name)=Value format. See the subclass for a list of valid properties.
CPFFile (byref) - Name of the CPF file the properties were retrieved from.

GetList()

_.Library.Status GetList ( _.Library.String  ID, _.Library.String  Name, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Returns the properties from a instance of a mapping section from a CPF file by value in $list format

Parameters:
ID - Instance ID for the mapping.
Name - Name of the instance within the mapping ID to retrieve.
CPFFile - Name of the CPF file to use, Default=current active CPF file.

Return value:
&nbsp&nbsp&nbsp&nbsp&nbsp $lb(Status,Result)
&nbsp&nbsp&nbsp&nbsp&nbsp where Result=$LB($LB(property name,value),...) for each property in the instance of the section

Modify()

_.Library.Status Modify ( _.Library.String  ID, _.Library.String  Name, _.Library.String  Properties, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Modify a mapping in a CPF file.

Parameters:
Namespace - Namespace of the mapping.
Name - Name of the mapping to modify.
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. See the subclass for a list of valid properties. If a specific property is not passed in the properties array, the value is not modified.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform. See the <METHOD>Create</METHOD> method for values.


Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.

Open()

_.Library.ObjectHandle Open ( _.Library.String  ID, _.Library.String  Name, _.Library.String  CPFFile, _.Library.Integer  concurrency, _.Library.Status  Status, _.Library.Integer  Flags  )

static

Open an instance of a mapping object in a CPF file.

Parameters:
Name - Name of the mapping to open
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform if the object is later saved with the Save() method. See the <METHOD>Create</METHOD> method for values.

Return Values:
CPFFile (byref) - Name of the CPF file the object was opened in.

Member Data Documentation

CAPITALNAME

CAPITALNAME = None

static

Determines if the Name specified in the index should be capitalized.

SECTIONTYPE

SECTIONTYPE = None

static

This parameter governs how the class creates audit records.

Value = 0 - Class contains a single entry (SQL, Net, etc.)
Value = 1 - Class contains multiple entries (Databases, Namespaces, etc.)
Value = 2 - Class deals with mappings (MapGlobals, MapRoutines, MapPackages.)