Interface ExternalDataClass
package com.ptc.pfc.pfcExternal;
public interface ExternalDataClass
extends com.ptc.pfc.pfcObject.Object
Description
A class that represents a named "bin" for external data so other applications will not use the data by mistake. An application usually needs one class.
Method Summary
CreateSlot (String Name) | |
Creates a new slot for the external data class | |
void | Delete () |
Deletes the external data class from the model | |
String | GetName () |
Get method for attribute "Name" Unique name of the class for this model | |
GetParent () | |
Get method for attribute "Parent" ExternalDataAccess object to which the class belongs | |
boolean | IsValid () |
Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed. | |
ListSlots () | |
Lists all the slots available for the class |
Method Detail
GetName | ||
String | GetName | () |
Unique name of the class for this model
Exceptions thrown (but not limited to):
XBadExternalData - Class is no longer valid
GetParent | ||
GetParent | () |
ExternalDataAccess object to which the class belongs
Exceptions thrown (but not limited to):
XBadExternalData - Class is no longer valid
IsValid | ||
boolean | IsValid | () |
Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed.
Returns:
The class status
Delete | ||
void | Delete | () |
Deletes the external data class from the model
Deletes permanenly the class and all its slots.
Exceptions thrown (but not limited to):
XExternalDataTKError - The function failed.
XExternalDataInvalidObject - The specified model or class name is invalid.
XBadExternalData - Class is no longer valid
Returns:
CreateSlot | ||
CreateSlot | (String Name) |
Creates a new slot for the external data class
Exceptions thrown (but not limited to):
XExternalDataTKError - The function failed.
XExternalDataInvalidObject - The specified model or class name is invalid.
XExternalDataClassOrSlotExists - The specified slot already exists in the specified class.
XExternalDataNamesTooLong - The specified slot or class name exceeds the length PRO_NAME_SIZE.
XBadExternalData - Class is no longer valid
Manual References:
Parameters:
Name
The unique name for the slot. This name cannot begin with a number.
Returns:
The new external data slot
ListSlots | ||
ListSlots | () |
Lists all the slots available for the class
Note that slots created by Creo Parametric TOOLKIT applications may not have cutomized names, just numbers.
Exceptions thrown (but not limited to):
XExternalDataTKError - The function failed.
XExternalDataInvalidObject - The model is invalid.
XExternalDataBadDataArgs - The slot ids and/or slot names are invalid.
XBadExternalData - Class is no longer valid
Manual References:
Returns:
Sequence of external data slots