Interface CheckoutOptions
Description
This class describes checkout options.
User Guide References:
Method Summary
/*cipOptional*/ ServerDependency | |
Get method for attribute "Dependency" Specifies the dependency rule while checking out dependents of the object that is selected for checkout. | |
/*cipOptional*/ Boolean | GetDownload () |
Get method for attribute "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. | |
/*cipOptional*/ ServerIncludeInstances | |
Get method for attribute "IncludeInstances" Specifies the rule while including instances from the family table during checkout. | |
/*cipOptional*/ Boolean | GetReadonly () |
Get method for attribute "Readonly" Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link. | |
/*cipOptional*/ stringseq | |
Get method for attribute "SelectedIncludes" Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can benull | |
/*cipOptional*/ String | GetVersion () |
Get method for attribute "Version" Specifies the version of the object that is checked out. | |
void | |
Set method for attribute "Dependency" Specifies the dependency rule while checking out dependents of the object that is selected for checkout. | |
void | SetDownload ( /*cipOptional*/ Boolean value) |
Set method for attribute "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. | |
void | |
Set method for attribute "IncludeInstances" Specifies the rule while including instances from the family table during checkout. | |
void | SetReadonly ( /*cipOptional*/ Boolean value) |
Set method for attribute "Readonly" Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link. | |
void | |
Set method for attribute "SelectedIncludes" Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can benull | |
void | SetVersion ( /*cipOptional*/ String value) |
Set method for attribute "Version" Specifies the version of the object that is checked out. |
Method Detail
GetDependency | ||
/*cipOptional*/ ServerDependency | GetDependency | () |
SetDependency | ||
void | SetDependency |
Specifies the dependency rule while checking out dependents of the object that is selected for checkout.
User Guide References:
GetIncludeInstances | ||
/*cipOptional*/ ServerIncludeInstances | GetIncludeInstances | () |
SetIncludeInstances | ||
void | SetIncludeInstances |
Specifies the rule while including instances from the family table during checkout.
User Guide References:
GetSelectedIncludes | ||
/*cipOptional*/ stringseq | GetSelectedIncludes | () |
SetSelectedIncludes | ||
void | SetSelectedIncludes |
Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null
User Guide References:
GetVersion | ||
/*cipOptional*/ String | GetVersion | () |
SetVersion | ||
void | SetVersion | ( /*cipOptional*/ String value) |
Specifies the version of the object that is checked out.
User Guide References:
GetDownload | ||
/*cipOptional*/ Boolean | GetDownload | () |
SetDownload | ||
void | SetDownload | ( /*cipOptional*/ Boolean value) |
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.
User Guide References:
GetReadonly | ||
/*cipOptional*/ Boolean | GetReadonly | () |
SetReadonly | ||
void | SetReadonly | ( /*cipOptional*/ Boolean value) |
Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.
User Guide References: