|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndependentlyPersistableObject
Represents a persistable IndependentObject
that you can directly create,
update, and delete.
Method Summary | |
---|---|
void |
addPendingAction(PendingAction pa)
Adds the specified pending action to this object's PendingActions collection. |
void |
clearPendingActions()
Clears out the list of pending actions for this object. |
void |
delete()
Adds a Delete pending action to this object's
PendingActions collection. |
java.lang.Integer |
getAccessAllowed()
Returns a value representing a bit mask of access rights granted to the user requesting this object. |
PendingAction[] |
getPendingActions()
Returns the pending actions for this object. |
java.lang.Integer |
getUpdateSequenceNumber()
Returns the update sequence number (USN) for this object. |
java.lang.Boolean |
isCurrent()
Returns a value indicating whether or not the state of this object is consistent with its state in the repository. |
void |
save(RefreshMode refreshMode)
Saves changes made to this object. |
void |
save(RefreshMode refreshMode,
PropertyFilter filter)
Saves changes made to this object. |
void |
setUpdateSequenceNumber(java.lang.Integer val)
Sets the update sequence number (USN) for this object. |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
java.lang.Integer getUpdateSequenceNumber()
An IndependentlyPersistableObject
has an update sequence number (USN), which
is an integer value on the object that protects it against concurrent updates.
The USN value increases monotonically with each update to the object.
When you update the object, the USN from the retrieved object is checked
against the currently persisted USN value. If the values are different, the operation
fails.
As a special case, a USN value of null
causes the server-side check
to be skipped during updates (this is sometimes called "unprotected update"). An
IndependentlyPersistableObject
instantiated by calling one of the
getInstance
methods on a Factory
class
(such as Factory.CustomObject.getInstance
) does not fetch the object from the
server and so is unaware of the persisted USN. Calling
getUpdateSequence
on such an object returns null
.
void setUpdateSequenceNumber(java.lang.Integer val)
null
.
val
- The new value for the USN, or null
to suppress update sequence checking.java.lang.Boolean isCurrent()
When one or more of the object's properties are "dirty" (have been marked as changed
since the last time they were saved), isCurrent
returns False
.
You can then do one of the following:
save
method or add the object to an UpdatingBatch
then call updateBatch
, which effectively calls save
on each
IndependentlyPersistableObject
in the batch.)refresh
method to cancel the changes and restore the object's
state to that of the persistent store.removeFromCache
.
Boolean
expression representing the object state. Returns
True
if the object's properties have not been changed; otherwise,
returns False
(the object has dirty properties).void delete()
Delete
pending action to this object's
PendingActions
collection. You must subsequently
commit the change to the repository. (See PendingAction
for more information about pending actions.)
void save(RefreshMode refreshMode)
refreshMode
- Specifies whether or not to refresh all of the object's properties.void save(RefreshMode refreshMode, PropertyFilter filter)
filter
parameter.
refreshMode
- Specifies whether or not to refresh all of the object's properties.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to refresh.
Specifying null
is the same as calling save(refreshMode)
.PendingAction[] getPendingActions()
PendingAction
objects.void addPendingAction(PendingAction pa)
PendingActions
collection.
(Note that you probably won't directly manipulate an object's pending actions in this
manner. You will more likely call wrapper methods such as delete
and
checkin
, which add a pending action to the collection.)
pa
- A PendingAction
object.void clearPendingActions()
delete()
without subsequently calling save
, then called
clearPendingActions()
, the Delete
pending action would no
longer be in the object's pending actions list. This effectively cancels
changes not yet saved.
java.lang.Integer getAccessAllowed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |