首页 / dm / oaCellViewDMData

oaCellViewDMData

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

概览

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

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

详细说明

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

方法总览

状态	Python 调用
✅	`obj.getCellName(cellName)`
✅	`obj.getCellName(ns, cellName)`
✅	`obj.getViewName(viewName)`
✅	`obj.getViewName(ns, viewName)`
✅	`obj.getViewType()`
✅	`_dm.oaCellViewDMData.open(libName, cellName, viewName, viewType, mode)`
✅	`_dm.oaCellViewDMData.open(libName, cellName, viewName, mode)`
✅	`_dm.oaCellViewDMData.recover(libName, cellName, viewName, saveRecoverType)`
✅	`_dm.oaCellViewDMData.find(libName, cellName, viewName)`
✅	`_dm.oaCellViewDMData.exists(libName, cellName, viewName)`
✅	`_dm.oaCellViewDMData.exists(libName, cellName, viewName, saveRecoverType)`
✅	`_dm.oaCellViewDMData.destroy(libName, cellName, viewName)`
✅	`_dm.oaCellViewDMData.destroy(libName, cellName, viewName, saveRecoverType)`

方法说明

`obj.getCellName(cellName)`

绑定状态: 已绑定

Python 调用: obj.getCellName(cellName)

This function returns name for this oaCellViewDMData object as an oaString in the specified namespace。

参数

ns: input parameter - the nameSpace in which to return the cell name。
cellName: the returned oaString cell name。

异常

oacInvalidCellView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaCellViewDMData
obj.getCellName(cellName)

`obj.getCellName(ns, cellName)`

绑定状态: 已绑定

Python 调用: obj.getCellName(ns, cellName)

This function returns the cell name for this CellDMData object。

参数

cellName: the returned oaScalarName cell name。

异常

oacInvalidCellView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaCellViewDMData
obj.getCellName(ns, cellName)

`obj.getViewName(viewName)`

绑定状态: 已绑定

Python 调用: obj.getViewName(viewName)

This function returns the view name for this oaCellViewDMData object in the specified nameSpace。

参数

ns: input parameter - the namespace in which to return the view name。
viewName: the returned oaString view name。

异常

oacInvalidCellView。

Python 示例

from oapy._oa import _dm

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

`obj.getViewName(ns, viewName)`

绑定状态: 已绑定

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

This function returns the view name for this oaCellViewDMData object。

参数

viewName: the returned oaScalarName view name。

异常

oacInvalidCellView。

Python 示例

from oapy._oa import _dm

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

`obj.getViewType()`

绑定状态: 已绑定

Python 调用: obj.getViewType()

This function returns the view type for this oaCellViewDMData object。

异常

oacInvalidCellView。

Python 示例

from oapy._oa import _dm

# assume obj is a oaCellViewDMData
obj.getViewType()

`_dm.oaCellViewDMData.open(libName, cellName, viewName, viewType, mode)`

绑定状态: 已绑定

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

This function attempts to open the oaCellViewDMData object for the cellView identified by the specified library, cell and view names with the specified mode。 If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaCellViewDMData does not exist, it will be created。 If the specified mode is a read-access mode ('r'ead-only mode) and the oaCellViewDMData does not exist, an oacDMDataDoesNotExist exception will be thrown。 If successful, a pointer to the CellViewDMData object is returned。

参数

libName: the name of the library associated with the DM Data。
cellName: the name of the cell associated with the DM Data。
viewName: the name of the view associated with the DM Data。
mode: 'read-only,' 'a'ppend, or 'w'rite mode in which to access the DMData; 'a'ppend and 'w'rite mode attempt to obtain write access to data; 'a'ppend retains any existing LibDMData; while'w'rite deletes (truncates) any existing DMData。

异常

oacOpenUndefinedModeDMData。
oacLibNotFound。
oacDMDataCannotGetReadAccess。
oacDMDataHasReadNeedWriteAccess。
oacDMDataCannotGetWriteAccess。
oacCellViewOwnerDoesNotExist。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.open(libName, cellName, viewName, viewType, mode)

`_dm.oaCellViewDMData.open(libName, cellName, viewName, mode)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.open(libName, cellName, viewName, mode)

This function attempts to open the DM data for the cellView specified with libName, cellName, viewName and viewType in the specified mode。 If the mode is not 'r'ead-only mode, the cell and view will be created if they did not exist prior to this open() call。 In the 'r'ead-only mode, the specified cellView and its owners must exist, otherwise an oacCellViewOwnerDoesNotExist exception is thrown。 Also, for existing cellViews, the viewType specified must match the existing view's viewType for the open to be successful。 An exception is thrown otherwise。 If successful, a pointer to the CellViewDMData object is returned。

参数

libName: the name of the library associated with the DM Data。
cellName: the name of the cell associated with the DM Data。
viewName: the name of the view associated with the DM Data。
viewType: the viewType of the cellView associated with the DM Data。
mode: 'read-only,' 'a'ppend, or 'w'rite mode in which to access the DMData; 'a'ppend and 'w'rite mode attempt to obtain write access to data; 'a'ppend retains any existing LibDMData; while'w'rite deletes (truncates) any existing DMData。

异常

oacOpenUndefinedModeDMData: undefined mode (must be 'r'ead-only, 'w'rite or 'a'ppend)。
oacCellViewOwnerDoesNotExist: read mode specified, but either or both the cell and view owners do not exist。
oacLibNotFound: the library with the specified name could not be found。
oacDMDataCannotGetReadAccess: requested read access to the DMData could not be obtained。
oacDMDataHasReadNeedWriteAccess: write access was requested but read access exists on DMData。
oacDMDataCannotGetWriteAccess: requested write access to the DMData could not be obtained。
oacOpenOnDMDataBeingPurged: attempt to open DMData while DMData is being purged。
oacDMDataDoesNotExist: read access requested, but DMData does not exist。
oacCannotLockDMData: write access specified, but cannot get a write lock on the file。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.open(libName, cellName, viewName, mode)

`_dm.oaCellViewDMData.recover(libName, cellName, viewName, saveRecoverType)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.recover(libName, cellName, viewName, saveRecoverType)

This function attempts to recover the DM data for the cellView specified by libName, cellName, viewName and with the specified oaSaveRecoverType 。 If successful, a pointer to the oaCellViewDMData object is returned。

参数

libName: The name of the library。
cellName: The name of the cell。
viewName: THe name of the view。
saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。

异常

oacLibNotFound。
oacCellViewOwnerDoesNotExist。
oacSaveRecoverDMDataFileAlreadyOpened。
oacOpenOnDMDataBeingPurged。
oacDMDataDoesNotExist。
oacSaveRecoverFileDoesNotExistOnDisk。
oacInterfaceException。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.recover(libName, cellName, viewName, saveRecoverType)

`_dm.oaCellViewDMData.find(libName, cellName, viewName)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.find(libName, cellName, viewName)

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

参数

libName: the name of the library associated with the DM Data。
cellName: the name of the cell。
viewName: the name of the view。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.find(libName, cellName, viewName)

`_dm.oaCellViewDMData.exists(libName, cellName, viewName)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.exists(libName, cellName, viewName)

This function returns a boolean that indicates whether the specified oaSaveRecoverType file exists on-disk。

参数

libName: The name of the library。
cellName: The name of the cell。
viewName: The name of the view。
saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.exists(libName, cellName, viewName)

`_dm.oaCellViewDMData.exists(libName, cellName, viewName, saveRecoverType)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.exists(libName, cellName, viewName, saveRecoverType)

This function returns a boolean that indicates if there is a CellViewDMData object open for the given library, cellName and viewName, or if a CellViewDMData file exists on disk with a non-zero size。

参数

libName: The name of the library associated with the DM Data。
cellName: The name of the cell。
viewName: The name of the view。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.exists(libName, cellName, viewName, saveRecoverType)

`_dm.oaCellViewDMData.destroy(libName, cellName, viewName)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.destroy(libName, cellName, viewName)

This function attempts to remove the specified oaSaveRecoverType file from disk。 It throws an exception if this file cannot be found on disk。

参数

libName: The name of the library。
cellName: The name of the cell。
viewName: The name of the view。
saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。

异常

oacLibNotFound。
oacDestroyDMDataDoesNotExist。
oacSaveRecoverFileDoesNotExistOnDisk。
oacInterfaceException。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.destroy(libName, cellName, viewName)

`_dm.oaCellViewDMData.destroy(libName, cellName, viewName, saveRecoverType)`

绑定状态: 已绑定

Python 调用: _dm.oaCellViewDMData.destroy(libName, cellName, viewName, saveRecoverType)

This function attempts to remove the CellViewDMData object associated with the given library, cellName and viewName from disk。 It throws an exception if the CellViewDMData is currently open or if the CellViewDMData cannot be found on disk。

参数

libName: The name of the library associated with the DM Data。
cellName: The name of the cell。
viewName: The name of the view。

异常

oacDestroyDMDataOpen。
oacDestroyDMDataDoesNotExist。
oacDMDataCannotGetWriteAccess。

Python 示例

from oapy._oa import _dm

_dm.oaCellViewDMData.destroy(libName, cellName, viewName, saveRecoverType)