Library | PackageFrames | Expand Java Toolkit

Interface WFamilyTableRow

package com.ptc.wfc.wfcFamily;

public interface WFamilyTableRow
  extends com.ptc.pfc.pfcFamily.FamilyTableRow


Description

Interface WFamilyTableRow adds more functionality to FamilyTableRow.


Method Summary
WModelGetModelFromDisk ()
    Retrieves an instance of a model from disk.
WModelGetModelFromSession ()
    Retrieves the handle to the instance model, if it is in session.
booleanIsFlatState ()
    Checks if the family table instance is a sheetmetal flat state instance or not.
booleanIsModifiable (boolean ShowUI)
    Check if a given instance is modifiable.

Methods Inherited from Interface com.ptc.pfc.pfcFamily.FamilyTableRow
GetInstanceName, GetIsLocked, SetIsLocked, GetIsVerified, GetIsExtLocked, CreateInstance, Erase

Method Detail

IsFlatState

booleanIsFlatState ()


    Checks if the family table instance is a sheetmetal flat state instance or not.

Exceptions thrown (but not limited to):

XToolkitBadContext - The instance is not of flat state type, but normal family table instance


Manual References:
Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances
Returns:
true if it is a flat state instance and false if not.

IsModifiable

booleanIsModifiable (boolean ShowUI)


    Check if a given instance is modifiable.
Manual References:
Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances
Parameters:
ShowUI
Indicates whether the Conflicts dialog should be shown to user to resolve conflicts (if they are detected); when set to false no UI is enabled and the instance is considered as modifiable if there are no conflicts that could not be overridden or resolved by default resolution actions.
Returns:
true if modifiable and false if not.

GetModelFromSession

WModelGetModelFromSession ()


    Retrieves the handle to the instance model, if it is in session.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance model is not in session.


Manual References:
Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances
Returns:
The model from session.

GetModelFromDisk

WModelGetModelFromDisk ()


    Retrieves an instance of a model from disk.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance model was not found on disk.


Manual References:
Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances
Returns:
The model from disk.