首页 / cms / oaChangeSetBase

oaChangeSetBase

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

概览

oaChangeSetBase 在 oapy 中可用，可通过 _cms 模块访问。

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

详细说明

The oaChangeSetBase class is the abstract base class for oaChangeSet , which defines its interface。 A change set manages individual change records, which represent changes made to a design。 The oaChangeSet and oaChangeRec classes are involved in the communication between tracking and export plug-ins in the OpenAccess change management system (CMS) 。

方法总览

状态	Python 调用
✅	`obj.getCurrentChangeRec(database)`
✅	`obj.beginChangeRec(database)`
✅	`obj.endChangeRec(database)`
✅	`obj.addChangeRec(lcr)`
✅	`obj.rollBackChangeRecs(dbRef, target=NULL, inclusive=false)`
✅	`obj.removeChangeRec(dbRef, rec)`
✅	`obj.passivateRefs(dbRef)`
✅	`obj.allocSetAttributeChangeRec(value)`
✅	`obj.allocUnsetAttributeChangeRec(owner, attr)`
✅	`obj.allocCreate1to1RelationshipChangeRec(value)`
✅	`obj.allocCreate1toNRelationshipChangeRec(value)`
✅	`obj.allocDestroy1to1RelationshipChangeRec(value)`
✅	`obj.allocDestroy1toNRelationshipChangeRec(value)`
✅	`obj.allocCreateObjectChangeRec(object, state)`
✅	`obj.allocDestroyObjectChangeRec(object)`
✅	`obj.allocConvertObjectChangeRec(object, newObject)`
✅	`obj.allocHierChangeRec()`
✅	`obj.findLastMarkerChangeRec(typeIn, dbRef)`
✅	`obj.findLastConvertObjectChangeRec(hcr)`
✅	`obj.allocExportMarkerChangeRec(typeIn, dbRef)`
✅	`obj.allocTransientMarkerChangeRec(typeIn, dbRef)`
✅	`obj.cloneMarkerChangeRec(cr)`
✅	`obj.cloneMarkerChangeRec(cr)`
✅	`obj.findDatabaseRef(obj)`
✅	`obj.allocDatabaseRef(obj, sd, isNew=false)`
✅	`obj.findObjectIDRef(database, obj)`
✅	`obj.allocObjectIDRef(database, obj, sd, isNew=false, scope=NULL)`
✅	`obj.findObjectStateRef(database, obj)`
✅	`obj.allocObjectStateRef(database, obj, sd, isNew=false, scope=NULL)`
✅	`obj.allocObjectStateEntry(database, def, attributes, relationships)`
✅	`obj.findStringEntry(database, string)`
✅	`obj.allocStringEntry(database, string)`
✅	`obj.accept(visitor)`
✅	`obj.accept(visitor, minAge=0)`
✅	`obj.getName(name)`
✅	`obj.isActive()`
✅	`obj.setActive(state)`
✅	`obj.isExported()`
✅	`obj.setExported()`
✅	`obj.getTimeStamp()`
✅	`obj.allocAttributeChangeRec(value, action, type)`
✅	`obj.allocRelationshipChangeRec(value, action, type)`

方法说明

`obj.getCurrentChangeRec(database)`

绑定状态: 已绑定

Python 调用: obj.getCurrentChangeRec(database)

This function gets the current hierarchical change record for the specified database。由 oaChangeSet 实现。

参数

database: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.getCurrentChangeRec(database)

`obj.beginChangeRec(database)`

绑定状态: 已绑定

Python 调用: obj.beginChangeRec(database)

This function begins a new hierarchical change record on the specified database。由 oaChangeSet 实现。

参数

database: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.beginChangeRec(database)

`obj.endChangeRec(database)`

绑定状态: 已绑定

Python 调用: obj.endChangeRec(database)

This function ends the current hierarchical change record on the specified database。由 oaChangeSet 实现。

参数

database: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.endChangeRec(database)

`obj.addChangeRec(lcr)`

绑定状态: 已绑定

Python 调用: obj.addChangeRec(lcr)

This function adds a leaf change record to the change set if there is no top-level hierarchical change record。由 oaChangeSet 实现。

参数

lcr: Pointer to the leaf change record to add to the change set。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.addChangeRec(lcr)

`obj.rollBackChangeRecs(dbRef, target=NULL, inclusive=false)`

绑定状态: 已绑定

Python 调用: obj.rollBackChangeRecs(dbRef, target=NULL, inclusive=false)

This function removes changes records from the change set associated with the specified database reference。 All changes that occurred after the target marker change record are removed。 If inclusive is set to true, the change marker itself is also removed。由 oaChangeSet 实现。

参数

dbRef: The database reference associated with the change set for which to rollback changes。
target: The marker change record to delimit the rollback。
inclusive: A boolean that specifies whether or not the target marker change record itself is removed as part of the rollback。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.rollBackChangeRecs(dbRef, target=NULL, inclusive=false)

`obj.removeChangeRec(dbRef, rec)`

绑定状态: 已绑定

Python 调用: obj.removeChangeRec(dbRef, rec)

由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.removeChangeRec(dbRef, rec)

`obj.passivateRefs(dbRef)`

绑定状态: 已绑定

Python 调用: obj.passivateRefs(dbRef)

This function passivates the references that describe the change records in the change set。由 oaChangeSet 实现。

参数

dbRef: The database reference for which to passivate references。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.passivateRefs(dbRef)

`obj.allocSetAttributeChangeRec(value)`

绑定状态: 已绑定

Python 调用: obj.allocSetAttributeChangeRec(value)

This function returns a pointer to an allocation record of the SetAttributeChangeRec type。由 oaChangeSet 实现。

参数

value: A smart pointer to the srAttribute。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocSetAttributeChangeRec(value)

`obj.allocUnsetAttributeChangeRec(owner, attr)`

绑定状态: 已绑定

Python 调用: obj.allocUnsetAttributeChangeRec(owner, attr)

This function returns a pointer to an allocation record of the UnsetAttributeChangeRec type。由 oaChangeSet 实现。

参数

owner: A smart pointer to the object reference for the object whose attribute was unset。
attr: A pointer to the schema definition for the attribute of an object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocUnsetAttributeChangeRec(owner, attr)

`obj.allocCreate1to1RelationshipChangeRec(value)`

绑定状态: 已绑定

Python 调用: obj.allocCreate1to1RelationshipChangeRec(value)

This function returns a pointer to an allocation record of the Create1to1RelationshipChangeRec type。由 oaChangeSet 实现。

参数

value: A smart pointer to the 1-to-1 relationship。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocCreate1to1RelationshipChangeRec(value)

`obj.allocCreate1toNRelationshipChangeRec(value)`

绑定状态: 已绑定

Python 调用: obj.allocCreate1toNRelationshipChangeRec(value)

This function returns a pointer to an allocation record of the Create1toNRelationshipChangeRec type。由 oaChangeSet 实现。

参数

value: A smart pointer to the 1-to-N relationship。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocCreate1toNRelationshipChangeRec(value)

`obj.allocDestroy1to1RelationshipChangeRec(value)`

绑定状态: 已绑定

Python 调用: obj.allocDestroy1to1RelationshipChangeRec(value)

This function returns a pointer to an allocation record of the oaDestroy1to1RelationshipChangeRec type。由 oaChangeSet 实现。

参数

value: A smart pointer to the 1-to-1 relationship that was destroyed。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocDestroy1to1RelationshipChangeRec(value)

`obj.allocDestroy1toNRelationshipChangeRec(value)`

绑定状态: 已绑定

Python 调用: obj.allocDestroy1toNRelationshipChangeRec(value)

This function returns a pointer to an allocation record of the oaDestroy1toNRelationshipChangeRec type。由 oaChangeSet 实现。

参数

value: A smart pointer to the 1-to-N relationship that was destroyed。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocDestroy1toNRelationshipChangeRec(value)

`obj.allocCreateObjectChangeRec(object, state)`

绑定状态: 已绑定

Python 调用: obj.allocCreateObjectChangeRec(object, state)

This function returns a pointer to an allocation record of the oaCreateObjectChangeRec type。由 oaChangeSet 实现。

参数

object: A smart pointer to an object reference。
state: A smart pointer to an oaCMObjectStateEntry , which identifies an object according to a set of unique attributes。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocCreateObjectChangeRec(object, state)

`obj.allocDestroyObjectChangeRec(object)`

绑定状态: 已绑定

Python 调用: obj.allocDestroyObjectChangeRec(object)

This function returns a pointer to an allocation record of the oaDestroyObjectChangeRec type。由 oaChangeSet 实现。

参数

object: A smart pointer to the object reference for an object that was destroyed。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocDestroyObjectChangeRec(object)

`obj.allocConvertObjectChangeRec(object, newObject)`

绑定状态: 已绑定

Python 调用: obj.allocConvertObjectChangeRec(object, newObject)

This function returns a pointer to an allocation record of the oaConvertObjectChangeRec type。 Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class。由 oaChangeSet 实现。

参数

object: A smart pointer to an object reference for the object before type-conversion。
newObject: A smart pointer to the new object reference after type-conversion。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocConvertObjectChangeRec(object, newObject)

`obj.allocHierChangeRec()`

绑定状态: 已绑定

Python 调用: obj.allocHierChangeRec()

This function returns a pointer to an allocation record of the oaHierChangeRec type。由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocHierChangeRec()

`obj.findLastMarkerChangeRec(typeIn, dbRef)`

绑定状态: 已绑定

Python 调用: obj.findLastMarkerChangeRec(typeIn, dbRef)

This function returns the last oaMarkerChangeRec of type typeIn on the list of change records associated with the specified database reference。由 oaChangeSet 实现。

参数

typeIn: Type of the oaMarkerChangeRec 。
dbRef: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findLastMarkerChangeRec(typeIn, dbRef)

`obj.findLastConvertObjectChangeRec(hcr)`

绑定状态: 已绑定

Python 调用: obj.findLastConvertObjectChangeRec(hcr)

This function finds the last oaConvertObjectChangeRec in the list of change records associated with the hcr hierarchical change record。 NULL is returned if one is not found。由 oaChangeSet 实现。

参数

hcr: A pointer to the hierarchical change record。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findLastConvertObjectChangeRec(hcr)

`obj.allocExportMarkerChangeRec(typeIn, dbRef)`

绑定状态: 已绑定

Python 调用: obj.allocExportMarkerChangeRec(typeIn, dbRef)

This function returns a pointer to an allocation record of the oaMarkerChangeRec type。由 oaChangeSet 实现。

参数

typeIn: The type of the change marker。
dbRef: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocExportMarkerChangeRec(typeIn, dbRef)

`obj.allocTransientMarkerChangeRec(typeIn, dbRef)`

绑定状态: 已绑定

Python 调用: obj.allocTransientMarkerChangeRec(typeIn, dbRef)

This function returns a pointer to an allocation record of the oaMarkerChangeRec type。由 oaChangeSet 实现。

参数

typeIn: The type of the change marker。
dbRef: A smart pointer to the database reference。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocTransientMarkerChangeRec(typeIn, dbRef)

`obj.cloneMarkerChangeRec(cr)`

绑定状态: 已绑定

Python 调用: obj.cloneMarkerChangeRec(cr)

This function creates an exact copy of the specified oaTransientMarkerChangeRec , including an identical timestamp。由 oaChangeSet 实现。

参数

cr: The oaTransientMarkerChangeRec to clone。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.cloneMarkerChangeRec(cr)

`obj.cloneMarkerChangeRec(cr)`

绑定状态: 已绑定

Python 调用: obj.cloneMarkerChangeRec(cr)

This function creates an exact copy of the specified oaExportMarkerChangeRec , including an identical timestamp。由 oaChangeSet 实现。

参数

cr: The oaExportMarkerChangeRec to clone。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.cloneMarkerChangeRec(cr)

`obj.findDatabaseRef(obj)`

绑定状态: 已绑定

Python 调用: obj.findDatabaseRef(obj)

This function attempts to find the database reference object managed by this change set。由 oaChangeSet 实现。

参数

obj: A pointer to an object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findDatabaseRef(obj)

`obj.allocDatabaseRef(obj, sd, isNew=false)`

绑定状态: 已绑定

Python 调用: obj.allocDatabaseRef(obj, sd, isNew=false)

This function returns a smart pointer to an allocation record of the oaCMDatabaseRef type。由 oaChangeSet 实现。

参数

obj: A pointer to the object。
sd: The schema definition of the database object。
isNew: A boolean that indicates whether or not this object is a newly created object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocDatabaseRef(obj, sd, isNew=false)

`obj.findObjectIDRef(database, obj)`

绑定状态: 已绑定

Python 调用: obj.findObjectIDRef(database, obj)

This function attempts to find the ID reference object managed by this change set。由 oaChangeSet 实现。

参数

database: A smart pointer to the database reference。
obj: A pointer to an object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findObjectIDRef(database, obj)

`obj.allocObjectIDRef(database, obj, sd, isNew=false, scope=NULL)`

绑定状态: 已绑定

Python 调用: obj.allocObjectIDRef(database, obj, sd, isNew=false, scope=NULL)

This function returns a smart pointer to an allocation record of the oaCMObjectIDRef type。由 oaChangeSet 实现。

参数

database: Smart pointer to the database reference。
obj: A pointer to an object。
sd: The schema definition of the object。
isNew: A boolean that indicates whether or not this object is a newly created object。
scope: The scope within the database to which the object belongs。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocObjectIDRef(database, obj, sd, isNew=false, scope=NULL)

`obj.findObjectStateRef(database, obj)`

绑定状态: 已绑定

Python 调用: obj.findObjectStateRef(database, obj)

This function attempts to find the state reference object managed by this change set。由 oaChangeSet 实现。

参数

database: A smart pointer to a database reference object。
obj: A pointer to an object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findObjectStateRef(database, obj)

`obj.allocObjectStateRef(database, obj, sd, isNew=false, scope=NULL)`

绑定状态: 已绑定

Python 调用: obj.allocObjectStateRef(database, obj, sd, isNew=false, scope=NULL)

This function returns a smart pointer to an allocation record of the oaCMObjectStateRef type。由 oaChangeSet 实现。

参数

database: A smart pointer to a database reference object。
obj: A pointer to an object。
sd: The schema definition of the object。
isNew: A boolean that indicates whether or not this object is a newly created object。
scope: The scope within the database to which the object belongs。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocObjectStateRef(database, obj, sd, isNew=false, scope=NULL)

`obj.allocObjectStateEntry(database, def, attributes, relationships)`

绑定状态: 已绑定

Python 调用: obj.allocObjectStateEntry(database, def, attributes, relationships)

This function returns a smart pointer to an allocation record of the oaCMObjectStateEntry type。由 oaChangeSet 实现。

参数

database: A smart pointer to a database reference object。
def: The schema definition of the object。
attributes: The attributes of the object state。
relationships: The relationships of the object state。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocObjectStateEntry(database, def, attributes, relationships)

`obj.findStringEntry(database, string)`

绑定状态: 已绑定

Python 调用: obj.findStringEntry(database, string)

This function finds the string entry in the database managed by this change set。由 oaChangeSet 实现。

参数

database: A smart pointer to the database reference object。
string: The string for which to find the string entry。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.findStringEntry(database, string)

`obj.allocStringEntry(database, string)`

绑定状态: 已绑定

Python 调用: obj.allocStringEntry(database, string)

This function returns a smart pointer to an allocation record of the oaCMStringEntry type。由 oaChangeSet 实现。

参数

database: A smart pointer to a database reference object。
string: The string to be contained in the string entry。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocStringEntry(database, string)

`obj.accept(visitor)`

绑定状态: 已绑定

Python 调用: obj.accept(visitor)

This function accepts a change record visitor and enables the visitor to access all the change records managed by this change set。由 oaChangeSet 实现。

参数

visitor: A pointer to the visitor to call on this object。
minAge: A timestamp that specifies the minimum age of the change records to visit。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.accept(visitor)

`obj.accept(visitor, minAge=0)`

绑定状态: 已绑定

Python 调用: obj.accept(visitor, minAge=0)

This function accepts a change set visitor。 It calls the visit function of the specified visitor on this object。由 oaChangeSet 实现。

参数

visitor: A pointer to the visitor to call on this object。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.accept(visitor, minAge=0)

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function retrieves the name of this change set in name。由 oaChangeSet 实现。

参数

name: The retrieved name of this change set。

Python 示例

from oapy._oa import _cms

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

`obj.isActive()`

绑定状态: 已绑定

Python 调用: obj.isActive()

This function returns a boolean indicating whether tracking is active on this change set。由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.isActive()

`obj.setActive(state)`

绑定状态: 已绑定

Python 调用: obj.setActive(state)

This function sets a boolean to indicate whether or not tracking is active on this change set。由 oaChangeSet 实现。

参数

state: True (active) or false (non-active)。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.setActive(state)

`obj.isExported()`

绑定状态: 已绑定

Python 调用: obj.isExported()

This function returns a boolean indicating whether or not this change set has been exported。由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.isExported()

`obj.setExported()`

绑定状态: 已绑定

Python 调用: obj.setExported()

This function sets the status of this change set to exported。由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.setExported()

`obj.getTimeStamp()`

绑定状态: 已绑定

Python 调用: obj.getTimeStamp()

A change set has a counter that it increments each time a change record is added。 This function returns the oaTimeStamp object that represents the current value of the counter。由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.getTimeStamp()

`obj.allocAttributeChangeRec(value, action, type)`

绑定状态: 已绑定

Python 调用: obj.allocAttributeChangeRec(value, action, type)

由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocAttributeChangeRec(value, action, type)

`obj.allocRelationshipChangeRec(value, action, type)`

绑定状态: 已绑定

Python 调用: obj.allocRelationshipChangeRec(value, action, type)

由 oaChangeSet 实现。

Python 示例

from oapy._oa import _cms

# assume obj is a oaChangeSetBase
obj.allocRelationshipChangeRec(value, action, type)