The GMS reservation (GMS_RES) ITK functions provide site check-out, site check-in, site cancel check-out, functionality. This uses the same mechanism that the RES module uses.i.e An ImanReservation object is associated with each checked out object via an IMAN_RES_checkout GRM relation. This reservation functionality gives the capability to reserve objects for other sites to modification.
Not all objects can be site checked out. The following classes and their sub-classes are valid for check-out:
-
Dataset
-
Form
-
Item
-
ItemRevision
-
PSBOMView
-
PSBOMViewRevision
To use reservation ITK functions, include the gms_res.h file in the source code.
The Site reservation functionality uses the following attributes of the ImanReservation:
| Attribute | Description |
| Site Reserved | A logical to differentiate the site check out from remote check out. |
| Remote site | Tag of the site to which the object is checked out. |
| Reservation Type | Integer that indicates whether check-out is with or without export. This attribute has RES_EXCLUSIVE_RESERVE for site checkout. |
| User | Tag to the user that currently holds the associated object's check-out. It can be a NULLTAG in case of replica |
| Group object | Tag of the group objectof the user who site checked out the object. It can be a NULLTAG in case of replica |
| Reservation State | Integer that holds ImanReservation object current check-out state. This attribute has RES_RESERVE |
| Notification List | VLA containing the tags of users that wish to be notified when the associated object's check-out status changes. |
| Date | A date_t that holds the date of the current check-out. |
| GMS_API int GMS_RES_cancel_site_check_out |
( |
tag_t |
object_tag | ) |
|
- Parameters
-
| object_tag | (I) Object to cancel checkout |
| GMS_API int GMS_RES_is_site_reserved |
( |
tag_t |
object_tag, |
|
|
logical * |
is_site_reserved, |
|
|
tag_t * |
site_tag |
|
) |
| |
- Parameters
-
| object_tag | (I) Object to be checked |
| is_site_reserved | (O) Is site checked out flag |
| site_tag | (O) The site to which it is checked out |
| GMS_API int GMS_RES_site_check_in |
( |
tag_t |
object_tag | ) |
|
- Parameters
-
| object_tag | (I) Object to checkin |
| GMS_API int GMS_RES_site_check_out |
( |
tag_t |
object_tag, |
|
|
tag_t |
site_tag, |
|
|
const char |
reason[WSO_desc_size_c+1], |
|
|
const char |
change_id[WSO_desc_size_c+1] |
|
) |
| |
- Deprecated:
- This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use GMS_RES_site_check_out2
- Parameters
-
| object_tag | (I) Object to checkout |
| site_tag | (I) Site to which to Checkout |
| reason | (I) Reason for checkout |
| change_id | (I) Change Id |
| GMS_API int GMS_RES_site_check_out2 |
( |
tag_t |
object_tag, |
|
|
tag_t |
site_tag, |
|
|
const char * |
reason, |
|
|
const char * |
change_id |
|
) |
| |
- Parameters
-
| object_tag | (I) Object to checkout |
| site_tag | (I) Site to which to Checkout |
| reason | (I) Reason for checkout |
| change_id | (I) Change Id |
