|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The BOChangeSummary interface represents the client programming model interface for the BOChangeSummary service. The BOChangeSummary service provides low level operations for reading and writing the Change Summary associated with a Business Graph. The Change Summary is a data structure defined by the Service Data Object specification that records the changes to an associated graph of Business Objects.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
void |
addOldValue(commonj.sdo.DataObject businessObject,
java.lang.String propertyPath,
java.lang.Object lastValue,
boolean lastIsSet)
Sets the old value and the isSet attributes of the property referenced by the combination of the Business Object and the property path in the Change Summary Setting for the property. |
void |
beginLogging(commonj.sdo.DataObject businessObject)
Initiate Change Summary logging while preserving the existing entries in the Change Summary. |
void |
clear(commonj.sdo.DataObject businessObject)
Clear all entries in the Change Summary associated with the object graph containing the Business Object. |
java.util.List |
getChangedProperties(commonj.sdo.DataObject businessObject)
Returns the list of all the changed properties of the Business Object. |
commonj.sdo.DataObject |
getOldContainer(commonj.sdo.DataObject businessObject)
Returns the Business Object that was the container of the Business Object before it was moved into the Change Summary. |
commonj.sdo.Property |
getOldContainmentProperty(commonj.sdo.DataObject businessObject)
Returns the Property of the Business Object that was the container of the Business Object before it was moved into the Change Summary. |
commonj.sdo.ChangeSummary.Setting |
getOldValue(commonj.sdo.DataObject businessObject,
java.lang.String propertyPath)
Returns the first Change Summary Setting associated with the property referenced by the combination of the Business Object and the property path. |
java.util.List |
getOldValues(commonj.sdo.DataObject businessObject,
java.lang.String propertyPath)
Returns the list of Change Summary Settings associated with the property referenced by the combination of the Business Object and the property path. |
boolean |
isUpdated(commonj.sdo.DataObject businessObject)
Determines whether the Change Summary associated with the Business Object has annotated the Business Object as Updated. |
void |
markCreated(commonj.sdo.DataObject businessObject)
Annotates the Business Object as Created in the Change Summary, such that ChangeSummary.isCreated() returns
true . |
void |
markDeleted(commonj.sdo.DataObject businessObject)
Annotates the Business Object as Deleted in the Change Summary, such that ChangeSummary.isDeleted() returns
true . |
void |
markListEntryMoved(java.lang.Object data,
commonj.sdo.DataObject businessObject,
java.lang.String propertyPath,
int newIndex)
Create a List Entry Moved annotation in the Change Summary for Object in the property represented by the combination of the Business Object and the property path. |
void |
markSimpleTypeCreated(java.lang.Object o,
commonj.sdo.DataObject businessObject,
java.lang.String propertyPath)
Marks a simple type object as Created. |
void |
markSimpleTypeDeleted(java.lang.Object o,
commonj.sdo.DataObject businessObject,
java.lang.String propertyPath)
Marks a simple type object as Deleted. |
void |
markUpdated(commonj.sdo.DataObject businessObject)
Annotates the Business Object as Updated in the Change Summary, such that BOChangeSummary.isUpdated() returns
true . |
void |
removeAllOldValues(commonj.sdo.DataObject businessObject)
Remove all the Change Summary Settings associated with the Business Object. |
void |
removeChanges(commonj.sdo.DataObject businessObject)
Removes the Created, Updated, and Deleted annotations for this Business Object in its associated Change Summary. |
void |
removeOldValue(commonj.sdo.ChangeSummary.Setting oldValue)
Remove the Change Summary Setting from the Change Summary. |
void |
removeOldValues(commonj.sdo.DataObject businessObject,
java.lang.String propertyPath)
Remove the Change Summary Settings associated with the property referenced by the combination of the Business Object and the property path. |
Field Detail |
public static final java.lang.String COPYRIGHT
Method Detail |
public void markCreated(commonj.sdo.DataObject businessObject)
ChangeSummary.isCreated()
returns
true
.The Business Object must be contained in a Business Graph that contains a Change Summary.
businessObject
- The Business Object to annotate as Createdpublic void markUpdated(commonj.sdo.DataObject businessObject)
BOChangeSummary.isUpdated()
returns
true
.The Business Object must be contained in a Business Graph that contains a Change Summary.
businessObject
- The Business Object to annotate as Updatedpublic void markDeleted(commonj.sdo.DataObject businessObject)
ChangeSummary.isDeleted()
returns
true
.The Business Object must be contained in a Business Graph that contains a Change Summary.
businessObject
- The Business Object to annotate as Deletedpublic boolean isUpdated(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object whose Change Summary
annotation will be checked against the Updated status
true
if the Business Object was annotated
as Updated, false
otherwise.public void removeChanges(commonj.sdo.DataObject businessObject)
The Business Object must be contained in a Business Graph that contains a Change Summary.
businessObject
- The Business Object whose Change Summary
annotations are to be removedpublic void addOldValue(commonj.sdo.DataObject businessObject, java.lang.String propertyPath, java.lang.Object lastValue, boolean lastIsSet)
businessObject
- The Business Object used in combination with the
property path to determine the property whose Change Summary value
needs to be setpropertyPath
- The property path used in combination with the
Business Object to determine the property whose Change Summary value
needs to be setlastValue
- The property's value to add to the Change SummarylastIsSet
- The property's isSet value to add to the Change Summarypublic commonj.sdo.ChangeSummary.Setting getOldValue(commonj.sdo.DataObject businessObject, java.lang.String propertyPath)
businessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the property
public java.util.List getOldValues(commonj.sdo.DataObject businessObject, java.lang.String propertyPath)
Note: The current Change Summary will contain only one Change Summary
setting so this method is functionally equivalent to
getOldValue()
.
businessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the property
public java.util.List getChangedProperties(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object whose changed properties
are being queried
public void removeOldValue(commonj.sdo.ChangeSummary.Setting oldValue)
oldValue
- Change Summary Setting to removepublic void removeOldValues(commonj.sdo.DataObject businessObject, java.lang.String propertyPath)
businessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the propertypublic void removeAllOldValues(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object used in combination with
the property path to reference the propertypublic void clear(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object that is part of the
Business Graph containing the Change Summarypublic void beginLogging(commonj.sdo.DataObject businessObject)
This operation is similar to ChangeSummary.beginLogging()
except the ChangeSummary beginLogging() operation clears the Change
Summary.
businessObject
- The Business Object that is part of the
Business Graph containing the Change Summarypublic commonj.sdo.DataObject getOldContainer(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object in the Change Summary
public commonj.sdo.Property getOldContainmentProperty(commonj.sdo.DataObject businessObject)
businessObject
- The Business Object in the Change Summary
public void markListEntryMoved(java.lang.Object data, commonj.sdo.DataObject businessObject, java.lang.String propertyPath, int newIndex)
data
- The object in the listbusinessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the propertynewIndex
- The new index of the item in the listpublic void markSimpleTypeCreated(java.lang.Object o, commonj.sdo.DataObject businessObject, java.lang.String propertyPath)
businessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the propertypublic void markSimpleTypeDeleted(java.lang.Object o, commonj.sdo.DataObject businessObject, java.lang.String propertyPath)
businessObject
- The Business Object used in combination with
the property path to reference the propertypropertyPath
- The property path used in combination with the
Business Object to reference the property
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |