oaViewDMData

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

概览

oaViewDMData 在 oapy 中可用，可通过 _dm 模块访问。

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

详细说明

oaViewDMData objects represent database objects that can be associated with a DM view and can be used to persistently store properties ( oaProp objects), groups ( oaGroup objects), group members ( oaGroupMember objects) and application objects (see oaAppObject )。

方法总览

状态	Python 调用
✅	obj.getViewName(viewName)
✅	obj.getViewName(ns, viewName)
✅	obj.getViewType()
✅	_dm.oaViewDMData.open(libName, viewName, viewType, mode)
✅	_dm.oaViewDMData.find(libName, viewName, viewType)
✅	_dm.oaViewDMData.exists(libName, viewName, viewType)
✅	_dm.oaViewDMData.destroy(libName, viewName, viewType)

方法说明

obj.getViewName(viewName)

绑定状态: 已绑定

Python 调用: obj.getViewName(viewName)

This function returns the name of the view to which this ViewDMData object belongs。

参数

• ns: The namespace to be used to populate the viewName parameter。
• viewName: A reference to an oaString object to be populated with the view name。

异常

• oacInvalidView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaViewDMData
obj.getViewName(viewName)

obj.getViewName(ns, viewName)

绑定状态: 已绑定

Python 调用: obj.getViewName(ns, viewName)

This function returns the name of the view to which this ViewDMData object belongs。

参数

• viewName: A reference to the oaScalarName object that will be populated with the name of the view。

异常

• oacInvalidView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaViewDMData
obj.getViewName(ns, viewName)

obj.getViewType()

绑定状态: 已绑定

Python 调用: obj.getViewType()

This function returns the viewType of the view to which this ViewDMData object belongs。

异常

• oacInvalidView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaViewDMData
obj.getViewType()

_dm.oaViewDMData.open(libName, viewName, viewType, mode)

绑定状态: 已绑定

Python 调用: _dm.oaViewDMData.open(libName, viewName, viewType, mode)

This function attempts to open the oaViewDMData object for the view with the specified name and viewType in the specified library with the specified mode。 If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaViewDMData does not exist, it will be created。 If the specified mode is a read-access mode ('r'ead-only mode) and the oaViewDMData does not exist, an oacDMDataDoesNotExist exception will be thrown。 If successful, a pointer to the ViewDMData object is returned。

参数

• libName: The name of the library。
• viewName: The name of the view whose ViewDMData is to be opened。
• viewType: The viewType of the view to be opened。
• mode: The mode in which to open the ViewDMData。

异常

• oacOpenUndefinedModeDMData。
• oacLibNotFound。
• oacViewNotFound。
• oacDMDataCannotGetReadAccess。
• oacDMDataHasReadNeedWriteAccess。
• oacDMDataCannotGetWriteAccess。

Python 示例

from oapy._oa import _dm

_dm.oaViewDMData.open(libName, viewName, viewType, mode)

_dm.oaViewDMData.find(libName, viewName, viewType)

绑定状态: 已绑定

Python 调用: _dm.oaViewDMData.find(libName, viewName, viewType)

This function attempts to find an open DM data for the given library。 If successful, a pointer to the DMData object is returned; otherwise, NULL is returned。

参数

• libName: The name of the library in which to look。
• viewName: The name of the view whose ViewDMData is to be found。
• viewType: The viewType of the view whose ViewDMData is to be found。

异常

• oacDMDataCannotGetReadAccess。

Python 示例

from oapy._oa import _dm

_dm.oaViewDMData.find(libName, viewName, viewType)

_dm.oaViewDMData.exists(libName, viewName, viewType)

绑定状态: 已绑定

Python 调用: _dm.oaViewDMData.exists(libName, viewName, viewType)

This function checks if there is a DMData open for the given library, or if a DMData file exists on disk with a non-zero size。

参数

• libName: The name of the library in which to look。
• viewName: The name of the view whose ViewDMData existence is to be checked。
• viewType: The viewType of the view whose ViewDMData existence is to be checked。

异常

• oacDMDataCannotGetReadAccess。

Python 示例

from oapy._oa import _dm

_dm.oaViewDMData.exists(libName, viewName, viewType)

_dm.oaViewDMData.destroy(libName, viewName, viewType)

绑定状态: 已绑定

Python 调用: _dm.oaViewDMData.destroy(libName, viewName, viewType)

This function attempts to remove the dmData from disk。 It throws an exception if the dmData is currently open or if the dmData cannot be found on disk。

参数

• libName: The name of the library to use。
• viewName: The name of the view whose ViewDMData is to be destroyed。
• viewType: The specific viewType of the view whose ViewDMData is to be destroyed。

异常

• oacDMDataHasReadNeedWriteAccess。
• oacDMDataCannotGetWriteAccess。
• oacLibNotFound。
• oacDestroyDMDataDoesNotExist。
• oacDestroyDMDataOpen。

Python 示例

from oapy._oa import _dm

_dm.oaViewDMData.destroy(libName, viewName, viewType)