POV Manager Class (clsPOVMgr)

fdmAPI.API.POVMgr.API Call

Table 7-14 POV Manager Class (clsPOVMgr)

API Call Methods/Properties/Object References Description
fCategoryKey Method Return the numerical category key for the specified category name.

Inputs: ByVal strCat As String

Output: Integer
fCategoryName Method Return the text name of a category for the specified category key.

Inputs: ByVal lngCatKey As Integer

Output: String
fCheckLocParent Method Check when the requested location is assigned as the MAPPING parent to any other location.

Inputs: ByVal strLoc As String

Output: Boolean
fCheckLocProf Method Return all behavior attributes for the specified location as a COM object of type "objLocProfile". This object also contains the key information of the location and the data segment assignment.

Inputs: ByVal strLoc As String

Output: objLocProfile

objLocProfile Properties:

  • blnAdapterImport

  • blnChild

  • blnExists

  • blnScriptImport

  • blnSeq

  • lngControlsType

  • lngLocKey

  • lngParentLocKey

  • lngRedFlagLevel

  • lngSegKey

  • lngType

  • strAdaptor

  • strCLogicGrp

  • strControlsApprover

  • strControlsApproverProxy

  • strControlsGrp1

  • strControlsGrp2

  • strControlsParent

  • strCurrency

  • strDataValue

  • strImportGrp

  • strIntgConfig1

  • strIntgConfig2

  • strIntgConfig3

  • strIntgConfig4

  • strLogicGrp

  • strNotes

  • strParent

  • strValEntityGrp

  • strValRuleGrp
fGetLocationName Method Return the text name of a location based on its numeric key.

Inputs: ByVal lngPartKey As Integer

Output: String
fPeriodKey Method Return attributes associated with the specified period value as a COM object of type "objPeriod". Use this procedure to return the prior period of a location by setting the optional parameter "blnPriorPer" to true. By default the procedure returns the target period associated with the 'M' or 'Monthly' frequency, but the optional parameter "strFreq" can be used to retrieve a target value associated with a different frequency.

Inputs: ByVal strPer As String, Optional ByVal blnPriorPer As Boolean = False, Optional ByVal strFreq As String = ""

Output: objPeriod

objPeriod Properties:

  • dblSerialKey

  • dteDateKey

  • strDateKey

  • strSerialKey

  • strTarget

  • strTargetYear