All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface VPMIBookingManager
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMIBookingManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface VPMIBookingManager
Method Index
- o
CreateNBookingWithConsecutiveIDs(ENOVIObjectInfo_var&,CATUnicodeString&,int,CATUnicodeString&,CATUnicodeString&,int,int,CATTimeSpan*)
- Create n line in Database to book the generated IDs for a given type.
- o
GetFreeBookedIDs(ENOVIObjectInfo_var&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfInt&)
- get the list of the free IDs
- o
UseBooking(SdaiAppInstance*,CATUnicodeString&,int)
-
- o
bookObject(SdaiAppInstance*,SdaiAppInstance*&,CATTimeSpan*)
-
- o
bookObjects(CATListPtrSdaiAppInstance*,CATTimeSpan*)
-
- o
deleteObjectsBooking(CATListPtrSdaiAppInstance*)
-
- o
end()
-
- o
init(int)
-
- o
isObjectBooked(SdaiAppInstance*,BookState*,CATUnicodeString&)
-
- o
setDefaultDelay(CATTimeSpan*)
-
Enumerated Type Index
- o
BookState
-
Methods
o CreateNBookingWithConsecutiveIDs
-
Create n line in Database to book the generated IDs for a given type.
- Parameters:
-
- iObjectInfo
- [in] the object info of the type.
- iAssignee
- [in] the string that owns the booking
- iNbBookingToCreate
- [in] the number of identifier to book.
- iPrefix
- [in] the prefix of the generated identifier.
- iSeparator
- [in] the separator of the generated identifier.
- iPadding
- [in] the padding to use to generate the identifier.
- iMaxSize
- [in] the max size of the generated identifier.
- iDelay
- [in] the delay of availability of the booking.
- Returns:
- S_OK : the booking are created.
E_FAIL: cannot book these IDs
o GetFreeBookedIDs
-
get the list of the free IDs
- Parameters:
-
- iObjectInfo
- [in] the object info of the type.
- iAssignee
- [in] the string that owns the booking.
- olFreeIds[out]
- the values of the availale booked IDs.
- olFreeButInUse
- [out] a list of int (0/1) to known which one are in use
- Returns:
- S_OK
E_FAIL
o UseBooking
-
o bookObject
-
o bookObjects
-
o deleteObjectsBooking
-
o end
-
o init
public virtual HRESULT init( | int | mode | = 0)=0 |
-
o isObjectBooked
-
o setDefaultDelay
-
Enumerated Types
o BookState
-
enum BookState {
BOOKED,
BOOKABLE,
NOTBOOKABLE
}
This object is included in the file: VPMIBookingManager.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces