Class pfcCheckoutOptions
Description
This class describes checkout options.
User Guide References:
Property Summary
/* optional */ pfcServerDependency | |
Specifies the dependency rule while checking out dependents of the object that is selected for checkout. | |
/* optional */ boolean | |
Specifies the checkout type as download or link. Download specifies that the object content is downloaded and checked out while link specifies that only the metadata is downloaded and checked out. | |
/* optional */ pfcServerIncludeInstances | |
Specifies the rule while including instances from the family table during checkout. | |
/* optional */ boolean | |
Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link. | |
/* optional */ stringseq | |
Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null | |
/* optional */ string | |
Specifies the version of the object that is checked out. |
Method Summary
static pfcCheckoutOptions | Create () |
Creates a new pfcCheckoutOptions object. |
Property Detail
/* optional */ pfcServerDependency | Dependency |
Specifies the dependency rule while checking out dependents of the object that is selected for checkout.
/* optional */ boolean | Download |
Specifies the checkout type as download or link. Download specifies that the object content is downloaded and checked out while link specifies that only the metadata is downloaded and checked out.
/* optional */ pfcServerIncludeInstances | IncludeInstances |
Specifies the rule while including instances from the family table during checkout.
/* optional */ boolean | Readonly |
Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.
/* optional */ stringseq | SelectedIncludes |
Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null
/* optional */ string | Version |
Specifies the version of the object that is checked out.
Method Detail
static pfcCheckoutOptions | Create | () |
Creates a new pfcCheckoutOptions object.
Returns:
The new object.
User Guide References: