API Documentation > Interfaces > Interface CheckoutOptions
Interface CheckoutOptions

package com.ptc.pfc.pfcServer;

public interface CheckoutOptions
extends jxobject


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