CIP JAVA documentation for class "com.ptc.pfc.pfcFamily.FamilyTableRow"

Interface FamilyTableRow

package com.ptc.pfc.pfcFamily; public interface FamilyTableRow extends com.ptc.pfc.pfcObject.Object

Description

This class specifies a row in a family table.

Method Summary
`Model`	`CreateInstance ()` Regenerates and adds the instance model to memory.
`void`	`Erase ()` Erases the specified instance model from memory.
`String`	`GetInstanceName ()` Get method for attribute "InstanceName" The name of the instance.
`boolean`	`GetIsExtLocked ()` Get method for attribute "IsExtLocked" If this is `true`, the instance is locked by external application.
`boolean`	`GetIsLocked ()` Get method for attribute "IsLocked" If this is `true`, the model is locked for modification. If this is `false`, the model is unlocked.
`FaminstanceVerifyStatus`	`GetIsVerified ()` Get method for attribute "IsVerified" Specifies the verification status of the instance.
`void`	`SetIsLocked (boolean value)` Set method for attribute "IsLocked" If this is `true`, the model is locked for modification. If this is `false`, the model is unlocked.

Method Detail

GetInstanceName

String GetInstanceName ()

The name of the instance.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

GetIsLocked/SetIsLocked

`boolean`	`GetIsLocked`	`()`
`void`	`SetIsLocked`	`(boolean value)`

If this is true, the model is locked for modification. If this is false, the model is unlocked.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance does not exist in the family table.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances, Family Tables: Accessing Instances

GetIsVerified

FaminstanceVerifyStatus GetIsVerified ()

Specifies the verification status of the instance.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance does not exist in the family table.

GetIsExtLocked

boolean GetIsExtLocked ()

If this is true, the instance is locked by external application.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance does not exist in the family table.

CreateInstance

Model CreateInstance ()

Regenerates and adds the instance model to memory.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.

XToolkitCantOpen - Creo Parametric cannot regenerate the instance. The instance has been created but the failed features have been suppressed.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances, Models: Getting a Model Object

Erase

void Erase ()

Erases the specified instance model from memory.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified instance model is not in session.