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

Interface DetailSymbolDefItem

package com.ptc.pfc.pfcDetail; public interface DetailSymbolDefItem extends com.ptc.pfc.pfcDetail.DetailItem

Description

This interface represents a symbol definition in a Creo Parametric model.

See Also:: DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailItemOwner.RetrieveSymbolDefinition(String, /*optional*/ String, /*optional*/ Integer, /*optional*/ Boolean)

Direct Known Subclasses:: WDetailSymbolDefItem

Method Summary
`DetailItem`	`CreateDetailItem (DetailCreateInstructions Instructions)` Creates a detail item in the symbol definition.
`DetailNoteItem`	`CreateFreeNote (DetailTextLines TextLines, FreeAttachment Attach)`
`DetailSymbolGroup`	`CreateSubgroup (DetailSymbolGroupInstructions Instructions, /optional/ DetailSymbolGroup ParentGroup)` Create a subgroup in the specified symbol group.
`/optional/ DetailItem`	`GetDetailItem (DetailType Type, int Id)` Returns a detail item in a symbol definition, given its id and type.
`DetailSymbolDefInstructions`	`GetInstructions ()` Returns an instructions data object describing how a symbol definition is constructed.
`boolean`	`IsSubgroupLevelExclusive ( /optional/ DetailSymbolGroup ParentGroup)` Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.
`/optional/ DetailItems`	`ListDetailItems ( /optional/ DetailType Type)` Lists the detail items in the symbol definition.
`/optional/ DetailSymbolGroups`	`ListSubgroups ()` List the subgroups in the symbol definition.
`void`	`Modify (DetailSymbolDefInstructions Instructions)` Modifies a symbol definition.
`void`	`SetSubgroupLevelExclusive ( /optional/ DetailSymbolGroup ParentGroup)` Set the symbol groups exclusive at specified level.
`void`	`SetSubgroupLevelIndependent ( /optional/ DetailSymbolGroup ParentGroup)` Set the symbol groups independent at specified level.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailItem`
`GetDetailType`, `Delete`

Method Detail

GetDetailItem

/*optional*/ DetailItem GetDetailItem (DetailType Type, int Id)

Returns a detail item in a symbol definition, given its id and type.

Exceptions thrown (but not limited to):

XToolkitNotFound - This means either:

No entities were found, OR
No notes were found.

XToolkitOutOfMemory - Found too many (either/all of) entities, notes to be contained in the output array. Use Visit instead.

Parameters:

Type: The detail type.
Id: The integer identifier.

Returns:: The detail item, or null, if the item was not found.

ListDetailItems

/*optional*/ DetailItems ListDetailItems ( /*optional*/ DetailType Type)

Lists the detail items in the symbol definition.

Exceptions thrown (but not limited to):

XToolkitNotFound - This means either:

No items were found, OR
No entities were found, OR
No groups were found, OR
No notes were found, OR
No symbol definitions were found, OR
No symbol instances were found.

XToolkitOutOfMemory - Found too many (either/all of) entities, groups, notes, symbol definitions, symbol instances to be contained in the output array. Use Visit instead.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Type: The type of detail items to list.

Returns:: The items found, or null, if no items were found.

CreateDetailItem

DetailItem CreateDetailItem (DetailCreateInstructions Instructions)

Creates a detail item in the symbol definition.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Instructions: The data item instructions. This should be a DetailEntityInstructions or DetailNoteInstructions object.

Returns:: The detail item created in the symbol definition.

CreateFreeNote

DetailNoteItem CreateFreeNote (DetailTextLines TextLines, FreeAttachment Attach)

Parameters:

TextLines
Attach

Returns:

GetInstructions

DetailSymbolDefInstructions GetInstructions ()

Returns an instructions data object describing how a symbol definition is constructed.

Manual References:: Drawings: Detail Symbol Definitions

Returns:: The instructions data object.

Modify

void Modify (DetailSymbolDefInstructions Instructions)

Modifies a symbol definition.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Instructions: Data object containing modifications to the symbol definition.

Returns:

CreateSubgroup

DetailSymbolGroup CreateSubgroup (DetailSymbolGroupInstructions Instructions, /*optional*/ DetailSymbolGroup ParentGroup)

Create a subgroup in the specified symbol group.

If no symbol group is specificed, the subgroup is created under the top level symbol group.

Exceptions thrown (but not limited to):

XToolkitInvalidName - A group with the provided name already exists at this level.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

Instructions: The characteristics for creating the subgroup.
ParentGroup: The symbol group under which the subgroup is to be made.

Returns:: The symbol group.

ListSubgroups

/*optional*/ DetailSymbolGroups ListSubgroups ()

List the subgroups in the symbol definition.

Exceptions thrown (but not limited to):

XToolkitNotFound - No groups are stored in the symbol definition at this level.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Returns:: The list of sub symbol groups.

IsSubgroupLevelExclusive

boolean IsSubgroupLevelExclusive ( /*optional*/ DetailSymbolGroup ParentGroup)

Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The exclusiveness is determined at the level of this symbol group. If not specifed, the top level is assumed.

Returns:: true if the subgroups are exclusive and false if independent.

SetSubgroupLevelExclusive

void SetSubgroupLevelExclusive ( /*optional*/ DetailSymbolGroup ParentGroup)

Set the symbol groups exclusive at specified level.

Once set exclusive, only one of the groups at this level may be active in the model at any time.

Exceptions thrown (but not limited to):

XToolkitNoChange - The status was already set to the designated value.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The symbol groups at the level of this symbol group are set exclusive. If not specified, the top level is assumed.

Returns:

SetSubgroupLevelIndependent

void SetSubgroupLevelIndependent ( /*optional*/ DetailSymbolGroup ParentGroup)

Set the symbol groups independent at specified level.

Once set independent, any number of groups at this level may be active in the model at any time.

Exceptions thrown (but not limited to):

XToolkitNoChange - The status was already set to the designated value.

Manual References:: Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The symbol groups at the level of this symbol group are set independent. If not specified, the top level is assumed.

Returns: