CIP JAVA documentation for class "com.ptc.pfc.pfcExternal.ExternalDataSlot"

Interface ExternalDataSlot

package com.ptc.pfc.pfcExternal; public interface ExternalDataSlot extends com.ptc.pfc.pfcObject.Object

Description

Represents a single data item stored in external data

Method Summary
`void`	`Delete ()` Deletes the external data slot
`ExternalDataClass`	`GetClass ()` Get method for attribute "Class" Class to which slot belongs
`int`	`GetId ()` Get method for attribute "Id" Unique identifier assigned by Creo Parametric
`/optional/ String`	`GetName ()` Get method for attribute "Name" Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.
`ExternalData`	`GetValue ()` Get method for attribute "Value" The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an `XBadExternalData`exception will result.
`boolean`	`IsValid ()` Returns true if the slot exists and can be accessed, false if it has been deleted.
`void`	`SetValue (ExternalData value)` Set method for attribute "Value" The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an `XBadExternalData`exception will result.

Method Detail

GetName

/*optional*/ String GetName ()

Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.

Exceptions thrown (but not limited to):

XBadExternalData - Slot is no longer valid

GetId

int GetId ()

Unique identifier assigned by Creo Parametric

Exceptions thrown (but not limited to):

XBadExternalData - Slot is no longer valid

GetClass

ExternalDataClass GetClass ()

Class to which slot belongs

Exceptions thrown (but not limited to):

XBadExternalData - Slot is no longer valid

IsValid

boolean IsValid ()

Returns true if the slot exists and can be accessed, false if it has been deleted.

Returns:: The status of the slot

Delete

void Delete ()

Deletes the external data slot

Permanently deletes the slot and the data it contains.

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The model or class name is invalid.

XExternalDataBadKeyByFlag - The 'key by flag' is invalid.

XExternalDataSlotNotFound - The slot was not found.

XBadExternalData - Slot is no longer valid

Returns:

GetValue/SetValue

`ExternalData`	`GetValue`	`()`
`void`	`SetValue`	`(ExternalData value)`

The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an XBadExternalDataexception will result.

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The model or class name is invalid.

XExternalDataBadKeyByFlag - The 'key by flag' is invalid.

XExternalDataSlotNotFound - The slot was not found.

XExternalDataStreamTooLarge - The stream data size is greater than 524288 bytes.

XExternalDataBadDataArgs - The data type or data size is invalid.

XExternalDataEmptySlot - No data exists in the slot.

XBadExternalData - Slot is no longer valid

Manual References:: External Data: Retrieving External Data, External Data: Retrieving External Data, External Data: Storing External Data