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

Interface ExternalDataAccess

package com.ptc.pfc.pfcExternal; public interface ExternalDataAccess extends com.ptc.pfc.pfcObject.Child

Description

Object that represents a conduit to the external data stored in the Creo Parametric file.

To make the external data available for the next session of Creo Parametric save the model.

Method Summary
`ExternalDataClass`	`CreateClass (String Name)` Creates a class in the model's external data.
`boolean`	`IsValid ()` Returns true if this object is still valid for this model, false if access has been terminated
`ExternalDataClasses`	`ListClasses ()` Lists all of the external data classes for the model
`void`	`LoadAll ()` Loads all of the model's external data into memory.
`void`	`ReleaseDataBuffer (ExternalData data)` Frees the memory allocated for data buffer.

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

Method Detail

ListClasses

ExternalDataClasses ListClasses ()

Lists all of the external data classes for the model

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The specified model is invalid.

XBadExternalData - Data access object is no longer valid

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

Returns:: Sequence of class objects.

CreateClass

ExternalDataClass CreateClass (String Name)

Creates a class in the model's external data.

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The specified model or class name is invalid.

XExternalDataClassOrSlotExists - The specified class name already exists.

XExternalDataNamesTooLong - The specified class name exceeds the length 32.

XBadExternalData - Data access object is no longer valid

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

Parameters:

Name: Name for the class. This must be unique, and typically reflects the name and/or purpose ofthe application.

Returns:: Object representing the new external data class.

LoadAll

void LoadAll ()

Loads all of the model's external data into memory.

Using this method can improve the performance of reading the model data.

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The specified model is invalid.

XBadExternalData - Data access object is no longer valid

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

Returns:

IsValid

boolean IsValid ()

Returns true if this object is still valid for this model, false if access has been terminated

Manual References:: External Data: Accessing External Data

Returns:: The status

ReleaseDataBuffer

void ReleaseDataBuffer (ExternalData data)

Frees the memory allocated for data buffer.

Parameters:

data

Returns: