public interface UserDefinedClass extends TransientObject
UserDefinedClassManager.newUserDefinedClass()
Modifier and Type | Interface and Description |
---|---|
static class |
UserDefinedClass.AllowOwnedObjectSelection
Allow owned object selection on all objects owned by an object of this
UserDefinedClass . |
static class |
UserDefinedClass.AllowQueryClass
Allow query class from name options for a
UserDefinedObject of this class. |
static interface |
UserDefinedClass.DisplayCallback
Prototype for display, selection, attention point, fit and screen-size-fit callbacks
|
static interface |
UserDefinedClass.GenericCallback
Prototype for information, edit, and suppress callbacks
|
static interface |
UserDefinedClass.LinkCallback
Prototype for update, and delete callbacks
|
static class |
UserDefinedClass.Selection
Allow query class from name options for a
UserDefinedObject . |
Modifier and Type | Method and Description |
---|---|
void |
addAttentionPointHandler(UserDefinedClass.DisplayCallback displayEvent)
Registers the attention point callback.
|
void |
addDeleteHandler(UserDefinedClass.LinkCallback linkEvent)
Registers the delete callback.
|
void |
addDisplayHandler(UserDefinedClass.DisplayCallback displayEvent)
Registers UDO display callback.
|
void |
addEditHandler(UserDefinedClass.GenericCallback udoEvent)
Registers the edit callback.
|
void |
addFitHandler(UserDefinedClass.DisplayCallback displayEvent)
Registers the fit callback.
|
void |
addInformationHandler(UserDefinedClass.GenericCallback udoEvent)
Registers the information callback.
|
void |
addScreenSizeFitHandler(UserDefinedClass.DisplayCallback displayEvent)
Registers the screen size fit callback.
|
void |
addSelectionHandler(UserDefinedClass.DisplayCallback displayEvent)
Registers the UDO selection callback.
|
void |
addSuppressHandler(UserDefinedClass.GenericCallback udoEvent)
Registers the suppress callback.
|
void |
addUpdateHandler(UserDefinedClass.LinkCallback linkEvent)
Registers the update callback.
|
UserDefinedClass.AllowOwnedObjectSelection |
allowOwnedObjectSelectionOption()
Returns the allow owned object selection flag.
|
UserDefinedClass.AllowQueryClass |
allowQueryClassFromName()
Returns the allow query class from name flag.
|
String |
className()
Returns the class name of the
UserDefinedClass . |
String |
friendlyName()
Returns the friendly name of the
UserDefinedClass . |
boolean |
getIsOccurrenceableFlag()
Gets the is occurrenceable flag for this class.
|
void |
setAllowOwnedObjectSelectionOption(UserDefinedClass.AllowOwnedObjectSelection allowOwnedObjectSelectionOption)
Sets the allow owned object selection flag.
|
void |
setAllowQueryClassFromName(UserDefinedClass.AllowQueryClass allowQueryClassFromName)
Sets the allow query class from name flag.
|
void |
setIsOccurrenceableFlag(boolean isOccurrenceable)
Sets the is occurrenceable flag for this class.
|
void |
setWarnUserFlag(boolean warnUser)
Sets the warn user flag.
|
boolean |
warnUserFlag()
Returns the warn user flag.
|
_value, dispose, printTestData, printTestData
String className() throws NXException, RemoteException
NXException
RemoteException
String friendlyName() throws NXException, RemoteException
NXException
RemoteException
UserDefinedClass.AllowQueryClass allowQueryClassFromName() throws NXException, RemoteException
UserDefinedObject
from the class name.
NXException
RemoteException
void setAllowQueryClassFromName(UserDefinedClass.AllowQueryClass allowQueryClassFromName) throws NXException, RemoteException
UserDefinedObject
from the class name.
allowQueryClassFromName
- NXException
RemoteException
UserDefinedClass.AllowOwnedObjectSelection allowOwnedObjectSelectionOption() throws NXException, RemoteException
UserDefinedObject
's of this class.
NXException
RemoteException
void setAllowOwnedObjectSelectionOption(UserDefinedClass.AllowOwnedObjectSelection allowOwnedObjectSelectionOption) throws NXException, RemoteException
UserDefinedObject
's of this class.
allowOwnedObjectSelectionOption
- NXException
RemoteException
boolean getIsOccurrenceableFlag() throws NXException, RemoteException
UserDefinedObject
's of this class.NXException
RemoteException
void setIsOccurrenceableFlag(boolean isOccurrenceable) throws NXException, RemoteException
isOccurrenceable
- Specifies whether or not to populate occurrences for UserDefinedObject
's of this class.NXException
RemoteException
boolean warnUserFlag() throws NXException, RemoteException
UserDefinedObject
of the given UserDefinedClass
is found in a part, but the code implementing the methods for the UDO is not loaded.
The default action is to not warn the user. If the UDO author sets this flag
to TRUE, all UDO's of this class that are created will be marked so that the
user will be warned if the UDO methods have not been loaded, but a UDO of the
class is in the part. This warning will be issued to the listing window,
when the first object of the given class is retrieved. This warning will
only be given once per session.
This flag is set on every UDO object. Therefore for any part, there may be a mixture UDO objects of a given class,
some having this flag set to TRUE and some objects having the flag set to FALSE. This is particularly true since all
UDO objects created before NX 3.0 will have this flag set to FALSE. If the UDO methods for a class are not loaded,
any one UDO with this flag set to TRUE in a part is enough for the warning to be issued to the listing window.
NXException
RemoteException
void setWarnUserFlag(boolean warnUser) throws NXException, RemoteException
UserDefinedObject
of the given UserDefinedClass
is found in a part, but the code implementing the methods for the UDO is not loaded.
The default action is to not warn the user. If the UDO author sets this flag
to TRUE, all UDO's of this class that are created will be marked so that the
user will be warned if the UDO methods have not been loaded, but a UDO of the
class is in the part. This warning will be issued to the listing window,
when the first object of the given class is retrieved. This warning will
only be given once per session.
This flag is set on every UDO object. Therefore for any part, there may be a mixture UDO objects of a given class,
some having this flag set to TRUE and some objects having the flag set to FALSE. This is particularly true since all
UDO objects created before NX 3.0 will have this flag set to FALSE. If the UDO methods for a class are not loaded,
any one UDO with this flag set to TRUE in a part is enough for the warning to be issued to the listing window.
warnUser
- TRUE - the user will be warned when opening a part containing a UDO of this class without first loading it's required methods. FALSE - the user will NOT be warned.NXException
RemoteException
void addDisplayHandler(UserDefinedClass.DisplayCallback displayEvent) throws NXException, RemoteException
displayEvent
- NXException
RemoteException
void addSelectionHandler(UserDefinedClass.DisplayCallback displayEvent) throws NXException, RemoteException
displayEvent
- NXException
RemoteException
void addAttentionPointHandler(UserDefinedClass.DisplayCallback displayEvent) throws NXException, RemoteException
displayEvent
- NXException
RemoteException
void addFitHandler(UserDefinedClass.DisplayCallback displayEvent) throws NXException, RemoteException
displayEvent
- NXException
RemoteException
void addScreenSizeFitHandler(UserDefinedClass.DisplayCallback displayEvent) throws NXException, RemoteException
addScreenSizeFitHandler(nxopen.userdefinedobjects.UserDefinedClass.DisplayCallback)
because to do
do would incur a performance penalty.
displayEvent
- NXException
RemoteException
void addUpdateHandler(UserDefinedClass.LinkCallback linkEvent) throws NXException, RemoteException
linkEvent
- NXException
RemoteException
void addDeleteHandler(UserDefinedClass.LinkCallback linkEvent) throws NXException, RemoteException
linkEvent
- NXException
RemoteException
void addInformationHandler(UserDefinedClass.GenericCallback udoEvent) throws NXException, RemoteException
udoEvent
- NXException
RemoteException
void addEditHandler(UserDefinedClass.GenericCallback udoEvent) throws NXException, RemoteException
udoEvent
- NXException
RemoteException
void addSuppressHandler(UserDefinedClass.GenericCallback udoEvent) throws NXException, RemoteException
udoEvent
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.