Library | Package Java Toolkit

Interface CheckoutOptions

package com.ptc.pfc.pfcServer;

public interface CheckoutOptions
  extends jxobject



Description

This class describes checkout options.



Method Summary
/*optional*/ ServerDependencyGetDependency ()
    Get method for attribute "Dependency"
    Specifies the dependency rule while checking out dependents of the object that is selected for checkout.
/*optional*/ BooleanGetDownload ()
    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.
/*optional*/ ServerIncludeInstancesGetIncludeInstances ()
    Get method for attribute "IncludeInstances"
    Specifies the rule while including instances from the family table during checkout.
/*optional*/ BooleanGetReadonly ()
    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*/ stringseqGetSelectedIncludes ()
    Get method for attribute "SelectedIncludes"
    Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null
/*optional*/ StringGetVersion ()
    Get method for attribute "Version"
    Specifies the version of the object that is checked out.
voidSetDependency ( /*optional*/ ServerDependency value)
    Set method for attribute "Dependency"
    Specifies the dependency rule while checking out dependents of the object that is selected for checkout.
voidSetDownload ( /*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.
voidSetIncludeInstances ( /*optional*/ ServerIncludeInstances value)
    Set method for attribute "IncludeInstances"
    Specifies the rule while including instances from the family table during checkout.
voidSetReadonly ( /*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.
voidSetSelectedIncludes ( /*optional*/ stringseq value)
    Set method for attribute "SelectedIncludes"
    Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null
voidSetVersion ( /*optional*/ String value)
    Set method for attribute "Version"
    Specifies the version of the object that is checked out.

Method Detail

GetDependency/SetDependency

/*optional*/ ServerDependencyGetDependency ()
voidSetDependency ( /*optional*/ ServerDependency 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



GetIncludeInstances/SetIncludeInstances

/*optional*/ ServerIncludeInstancesGetIncludeInstances ()
voidSetIncludeInstances ( /*optional*/ ServerIncludeInstances value)


    Specifies the rule while including instances from the family table during checkout.
Manual References:
Windchill Connectivity APIs: Checkout and Download



GetSelectedIncludes/SetSelectedIncludes

/*optional*/ stringseqGetSelectedIncludes ()
voidSetSelectedIncludes ( /*optional*/ stringseq 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



GetVersion/SetVersion

/*optional*/ StringGetVersion ()
voidSetVersion ( /*optional*/ String value)


    Specifies the version of the object that is checked out.
Manual References:
Windchill Connectivity APIs: Checkout and Download



GetDownload/SetDownload

/*optional*/ BooleanGetDownload ()
voidSetDownload ( /*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:
Windchill Connectivity APIs: Checkout and Download, Windchill Connectivity APIs: Checkout and Download



GetReadonly/SetReadonly

/*optional*/ BooleanGetReadonly ()
voidSetReadonly ( /*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:
Windchill Connectivity APIs: Checkout and Download