PspID (Object)

Represents the interface to generate and set IDs for the Distributive System Objects.
Role: This is the interface for Plant Ship object ID generation.

Methods


Func GenAndPutID() As
Returns the Generated ID with the sequence number and is stored on the object.
Returns:
ID generated
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenAndPutID
Func GenAndPutIDNoGenSeqNum() As
Generates ID without the sequence number and is stored on the object.
Returns:
ID generated
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenAndPutIDNoGenSeqNum
Func GenIDNoGenSeqNum() As
Generates ID without the sequence number( if not set previously) and is not stored on the object.
Parameters:
oGeneratedID
ID generated
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenIDNoGenSeqNum
Func GetID() As
Gets ID for the object.
Returns:
ID of the object.
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GetID
Func GetLocalID() As
Retrieves local ID of the object.
Returns:
Local ID generated
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GetLocalID
Func IsIDGenerated() As
Checks if the ID on the object is generated( based on the ID Schema).
Parameters:
oBIsGenerated
TRUE if ID is generated from the ID schema
Example: 
 
 Dim objThisIntf As PspID
 
 Dim bVar1 As boolean
  ...
 bVar1 =objThisIntf.IsIDGenerated
Sub SetID( iID)
Sets ID for the object.
Parameters:
oID
ID to be set.
Example: 
 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 objThisIntf.SetID iStrVar1