首页 / base / oaGroupDef

oaGroupDef

模块: oapy._oa._base 导入: from oapy._oa import _base

概览

oaGroupDef 在 oapy 中可用，可通过 _base 模块访问。

本页汇总 oaGroupDef 当前在 oapy 中可用的 Python 接口。

详细说明

This is a public managed class that specifies a definition for a group。 The definition contains a name, a list of object types that can be placed in the group, and a list of databases by type in which the group can be created。 See Using Group Definitions in the Programmers Guide for more information。

方法总览

状态	Python 调用
✅	`obj.getName(name)`
✅	`obj.getValidTypes(validTypes)`
✅	`obj.getValidDatabases(validDatabases)`
✅	`obj.isBuiltIn()`
✅	`obj.destroy()`
✅	`obj.remove(database)`
✅	`_base.oaGroupDef.find(name)`
✅	`_base.oaGroupDef.get(groupDefType)`

方法说明

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this group definition。

参数

name: The returned name of this group definition。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.getName(name)

`obj.getValidTypes(validTypes)`

绑定状态: 已绑定

Python 调用: obj.getValidTypes(validTypes)

This function returns the valid types of objects that can be added to a group with this definition。

参数

validTypes: The returned managed type array of valid names。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.getValidTypes(validTypes)

`obj.getValidDatabases(validDatabases)`

绑定状态: 已绑定

Python 调用: obj.getValidDatabases(validDatabases)

This function returns the valid types of databases in which a group specified with this definition can be created。

参数

validDatabases: The returned valid database types。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.getValidDatabases(validDatabases)

`obj.isBuiltIn()`

绑定状态: 已绑定

Python 调用: obj.isBuiltIn()

This function returns true if this group def is a built-in def。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.isBuiltIn()

`obj.destroy()`

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this group definition。 If it is a built-in definition or there are databases referencing this definition, an exception is thrown。 If the group definition is a valid group definition in other hierarchical definitions, an exception is thrown as well。 An exception is also thrown if this function is called when undo is enabled on any of the current in-memory design or tech databases。

异常

oacUnableToDestroyBuiltInType。
oacObjectDefHasReference。
oacCannotDestroyDefUndo。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.destroy()

`obj.remove(database)`

绑定状态: 已绑定

Python 调用: obj.remove(database)

This function removes this group definition from the specified database。 If there are any groups in the specified database that reference this definition, an error is thrown。

参数

database: The database in which the group definition is removed。

异常

oacObjectDefHasReference。

Python 示例

from oapy._oa import _base

# assume obj is a oaGroupDef
obj.remove(database)

`_base.oaGroupDef.find(name)`

绑定状态: 已绑定

Python 调用: _base.oaGroupDef.find(name)

This function returns the group definition with the name specified。 If no definition with the specified name is found, NULL is returned。

参数

name: The name of the group definition to match。

Python 示例

from oapy._oa import _base

_base.oaGroupDef.find(name)

`_base.oaGroupDef.get(groupDefType)`

绑定状态: 已绑定

Python 调用: _base.oaGroupDef.get(groupDefType)

This function returns the group definition with the specified group purpose type。

参数

groupDefType: The group purpose type to match。

Python 示例

from oapy._oa import _base

_base.oaGroupDef.get(groupDefType)