CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailGroupInstructions"

Interface DetailGroupInstructions

package com.ptc.pfc.pfcDetail; public interface DetailGroupInstructions extends com.ptc.pfc.pfcDetail.DetailCreateInstructions

Description

This interface contains information used to describe a detail group item. It may be used when creating detail groups (DetailItemOwner.CreateDetailItem(DetailCreateInstructions)), or accessing existing groups (DetailGroupItem.Modify(DetailGroupInstructions) and DetailGroupItem.GetInstructions()).

Method Summary
`DetailItems`	`GetElements ()` Get method for attribute "Elements" Sequence of detail items contained in the group.
`/optional/ Boolean`	`GetIsDisplayed ()` Get method for attribute "IsDisplayed" `true` if the group is displayed in the drawing, otherwise `false`.
`String`	`GetName ()` Get method for attribute "Name" The name of the detail group.
`void`	`SetElements (DetailItems value)` Set method for attribute "Elements" Sequence of detail items contained in the group.
`void`	`SetIsDisplayed ( /optional/ Boolean value)` Set method for attribute "IsDisplayed" `true` if the group is displayed in the drawing, otherwise `false`.
`void`	`SetName (String value)` Set method for attribute "Name" The name of the detail group.

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailCreateInstructions`
`GetType`, `GetId`

Method Detail

GetName/SetName

`String`	`GetName`	`()`
`void`	`SetName`	`(String value)`

The name of the detail group.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

GetElements/SetElements

`DetailItems`	`GetElements`	`()`
`void`	`SetElements`	`(DetailItems value)`

Sequence of detail items contained in the group.

Exceptions thrown (but not limited to):

XToolkitInvalidType - Invalid type of one of item.

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - The group does not contain any items.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

GetIsDisplayed/SetIsDisplayed

`/optional/ Boolean`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`( /optional/ Boolean value)`

true if the group is displayed in the drawing, otherwise false.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions