CIP C++ documentation for class "pfcCheckoutOptions"

Class pfcCheckoutOptions

# include <pfcServer.h> class pfcCheckoutOptions : public virtual xobject { xdeclare(pfcCheckoutOptions) ... }; This is a COMPACT class.

Description

This class describes checkout options.

Manual References:: Windchill Connectivity APIs: Checkout and Download

Method Summary


`static pfcCheckoutOptions_ptr`	`Create ()`
	Creates a new `pfcCheckoutOptions` object.

`optional pfcServerDependency`	`GetDependency ()`
`void`	`SetDependency (optional pfcServerDependency value)`
	Specifies the dependency rule while checking out dependents of the object that is selected for checkout.

`optional xbool`	`GetDownload ()`
`void`	`SetDownload (optional xbool 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.

`optional pfcServerIncludeInstances`	`GetIncludeInstances ()`
`void`	`SetIncludeInstances (optional pfcServerIncludeInstances value)`
	Specifies the rule while including instances from the family table during checkout.

`optional xbool`	`GetReadonly ()`
`void`	`SetReadonly (optional xbool value)`
	Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.

`optional xstringsequence_ptr`	`GetSelectedIncludes ()`
`void`	`SetSelectedIncludes (optional xstringsequence_ptr value)`
	Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be `null`

`optional xstring`	`GetVersion ()`
`void`	`SetVersion (optional xrstring value)`
	Specifies the version of the object that is checked out.

Method Detail

`optional pfcServerDependency`	`GetDependency`	`()`
`void`	`SetDependency`	`(optional pfcServerDependency value)`

Specifies the dependency rule while checking out dependents of the object that is selected for checkout.

Manual References:: Windchill Connectivity APIs: Checkout and Download

`optional pfcServerIncludeInstances`	`GetIncludeInstances`	`()`
`void`	`SetIncludeInstances`	`(optional pfcServerIncludeInstances value)`

Specifies the rule while including instances from the family table during checkout.

Manual References:: Windchill Connectivity APIs: Checkout and Download

`optional xstringsequence_ptr`	`GetSelectedIncludes`	`()`
`void`	`SetSelectedIncludes`	`(optional xstringsequence_ptr value)`

Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null

Manual References:: Windchill Connectivity APIs: Checkout and Download

`optional xstring`	`GetVersion`	`()`
`void`	`SetVersion`	`(optional xrstring value)`

Specifies the version of the object that is checked out.

Manual References:: Windchill Connectivity APIs: Checkout and Download

`optional xbool`	`GetDownload`	`()`
`void`	`SetDownload`	`(optional xbool 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.

Manual References:: Windchill Connectivity APIs: Checkout and Download

`optional xbool`	`GetReadonly`	`()`
`void`	`SetReadonly`	`(optional xbool value)`

Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.

Manual References:: Windchill Connectivity APIs: Checkout and Download

static pfcCheckoutOptions_ptr Create ()

Creates a new pfcCheckoutOptions object.

Manual References:: Windchill Connectivity APIs: Checkout and Download, Windchill Connectivity APIs: Checkout and Download

Returns:: The new object.