public interface IDfPersistentObject extends IDfTypedObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CURRENCY_CHECK_ALWAYS
Currency check value to always check if the object is current.
|
static java.lang.String |
CURRENCY_CHECK_FIRST_ACCESS
Currency check value to only check currency for the first access.
|
static java.lang.String |
CURRENCY_CHECK_NEVER
Currency check value to never check if the object is current.
|
static java.lang.String |
CURRENCY_CHECK_ONCE_PER_SCOPE
Currency check value to only check currency once per currency scope.
|
Modifier and Type | Method and Description |
---|---|
IDfRelation |
addChildRelative(java.lang.String relationTypeName,
IDfId childId,
java.lang.String childLabel,
boolean isPermanent,
java.lang.String description)
Creates a Relation object.
|
IDfRelation |
addParentRelative(java.lang.String relationTypeName,
IDfId parentId,
java.lang.String childLabel,
boolean isPermanent,
java.lang.String description)
Creates a Relation object.
|
boolean |
apiExec(java.lang.String cmd,
java.lang.String args)
Deprecated.
DMCL passthrough should not be used anymore
|
java.lang.String |
apiGet(java.lang.String cmd,
java.lang.String args)
Deprecated.
DMCL passthrough should not be used anymore
|
boolean |
apiSet(java.lang.String cmd,
java.lang.String args,
java.lang.String value)
Deprecated.
DMCL passthrough should not be used anymore
|
void |
destroy()
Removes the object from the Documentum server.
|
boolean |
fetch(java.lang.String typeNameIgnored)
Fetches this object from the repository without placing a lock on the object.
|
boolean |
fetchWithCaching(java.lang.String currencyCheckValue,
boolean usePersistentCache,
boolean useSharedCache)
Fetches this object from the repository without placing a lock on the object.
|
IDfList |
getAttrAssistance(java.lang.String attrName)
Deprecated.
use getValidator and then call getValueAssistance on IDfValidator instead
|
IDfList |
getAttrAssistanceWithValues(java.lang.String attrName,
IDfList depAttrNameList,
IDfList depAttrValueListList)
Deprecated.
use getValidator and then call getValueAssistance on IDfValidator instead
|
IDfList |
getAttrAsstDependencies(java.lang.String attrName)
Deprecated.
use getValidator and then call getValueAssistanceDependencies on IDfValidator instead
|
IDfCollection |
getChildRelatives(java.lang.String relationTypeName)
Returns a collection of IDfRelation objects where parent is this object, and the relation_name matches
the value passed in as a parameter.
|
IDfCollection |
getParentRelatives(java.lang.String relationTypeName)
Returns a collection of IDfRelation objects where child is this object, and the relation_name matches
the value passed in as a parameter.
|
int |
getPartition()
Returns i_partition for this object.
|
IDfType |
getType()
Provides an IDfType interface representing the type of this object.
|
IDfValidator |
getValidator()
Returns the IDfValidator interface that is assocated with this persistent object instance (the
IDfValidator shall provide validation-related services).
|
int |
getVStamp()
Returns the version stamp for this object.
|
java.lang.String |
getWidgetType(int environment,
java.lang.String attrName)
Deprecated.
use getValidator and then call getWidgetType on IDfValidator instead
|
boolean |
isDeleted()
Returns
true if this object has been deleted during this session. |
boolean |
isDirty()
Indicates whether unsaved changes have been made to this object.
|
boolean |
isInstanceOf(java.lang.String typeName)
Indicates if this is an object of the given type or of a type derived from the given type.
|
boolean |
isNew()
Indicates whether this object was created during the current session but has not yet been saved.
|
boolean |
isReplica()
Indicates whether an object is a replica.
|
void |
lock()
Acquires a low-level repository database lock on the object.
|
void |
lockEx(boolean validateStamp)
Acquires a low-level repository database lock on the object.
|
void |
registerEvent(java.lang.String message,
java.lang.String event,
int priority,
boolean sendMail)
Registers the current user to receive notifications when the
specified event occurs on the specified object.
|
void |
removeChildRelative(java.lang.String relationTypeName,
IDfId childId,
java.lang.String childLabel)
This method should be invoked on the parent object to abandon its relationship with one or more
children.
|
void |
removeParentRelative(java.lang.String relationTypeName,
IDfId parentId,
java.lang.String childLabel)
This method should be invoked on the child object to abandon its relationship with one or more
parents.
|
void |
revert()
Discards any changes to an object that have not been saved to a repository.
|
void |
save()
Saves an object to a Documentum server.
|
void |
setPartition(int partition)
Set i_partition for this object.
|
void |
signoff(java.lang.String user,
java.lang.String os_password,
java.lang.String reason)
Creates an audit trail entry of signoff information for an object.
|
void |
unRegisterEvent(java.lang.String event)
Removes the current user's registration for a specified event.
|
void |
unRegisterEventEx(java.lang.String event,
java.lang.String userName)
Removes the current user's registration for a specified event.
|
void |
validateAllRules(int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAll on IDfValidator instead
|
void |
validateAttrRules(java.lang.String attrName,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
validateAttrRulesWithValue(java.lang.String attrName,
java.lang.String value,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
validateAttrRulesWithValues(java.lang.String attrName,
IDfList valueList,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
validateObjRules(int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAllObjRules on IDfValidator instead
|
void |
validateObjRulesWithValues(IDfList attrNameList,
IDfList valueListList,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAllObjRules on IDfValidator instead
|
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final java.lang.String CURRENCY_CHECK_ALWAYS
static final java.lang.String CURRENCY_CHECK_NEVER
static final java.lang.String CURRENCY_CHECK_FIRST_ACCESS
static final java.lang.String CURRENCY_CHECK_ONCE_PER_SCOPE
boolean isDeleted() throws DfException
true
if this object has been deleted during this session. This method will not
return true
if the object was deleted on another session or by another user. In addition,
if this method is called on a Sysobject and that object is the root version of a version tree, deleting
this object sets this attribute to true
.DfException
- if server error occursboolean isDirty() throws DfException
true
if unsaved changes have been made to the object; false
if notDfException
- if server error occursboolean isNew() throws DfException
true
if the object was created during the current session but has not yet been
saved. false
if the object was created during the current session and saved, or
if it was not created during the current session.DfException
- if a server error occursboolean isReplica() throws DfException
DfException
- if a server error occursIDfType getType() throws DfException
DfException
- if a server error occursboolean isInstanceOf(java.lang.String typeName) throws DfException
typeName
- a type nameDfException
- if a server error occursint getVStamp() throws DfException
DfException
- if a server error occursIDfValidator getValidator() throws DfException
IDfId objId = new DfId("0900d5bb8001f900"); IDfPersistentObject perObj = sess.getObject(objId); IDfValidator validator = perObj.getValidator(); validator.validateAll(null, false);
DfException
boolean fetch(java.lang.String typeNameIgnored) throws DfException
fetch
method.
Without a lock, there is no guarantee that you will be able to save any changes you make to the object
since another user may checkout the object while you have it fetched. If you fetch an object, you
cannot use the checkin
method to write the object back to the repository. You must use the
save
method.typeNameIgnored
- The type name argument is ignored because the type name was set or determined at
creation of the DfPersistentObject and is therefore already known. Overriding
the value here would just cause an error. The parameter still exists for
backward compatability, but should be specified as null.DfException
- if a server error occursrevert()
,
fetchWithCaching(java.lang.String, boolean, boolean)
boolean fetchWithCaching(java.lang.String currencyCheckValue, boolean usePersistentCache, boolean useSharedCache) throws DfException
currencyCheckValue
- specifies that the object should be persistently cached and indicates how
often the object needs to checked for consistency with the server. If the
value is numeric it indicates the time (in seconds) which the caller is
willing to allow the object to be used without being rechecked for
consistency. If the requested object is found in the cache and has not been
checked for consistency in the specified time period then it is checked and
re-fetched from the server if necessary. If the value is non-numeric then it
specifies a cache configuration object which defines the consistency check
rules. Specify null
if you don't want the object persistently
cached.usePersistentCache
- set to true
if want the object the object cached persistentlyuseSharedCache
- Reserved for future use.true
if the method discovered a newer version of the object on the server. In
such cases, all unsaved changes that you have made to the object are lost. false
if the method did not discover a newer version of the object on the server.DfException
- if a server error occursfetch(java.lang.String)
void save() throws DfException
save
method.
The save
is generally used to save a newly created object in a Documentum server. You can
also use it when you want to save changes to an object without creating a new version. This method
overwrites the previously saved version with the local copy of the object.
This method might fail if you fetched the object from a Documentum server rather than checked it out.
Fetching an object does not place a lock on the object, and other users may have checked out or fetched
and saved the object while you were working on it.
Note that you cannot save a load record object while an explicit transaction is open.
The following code example demonstrates how to save an object:
IDfSysObject sysObj = session.newObject("dm_document"); sysObj.setContentType("wp7"); sysObj.setFile("chap_1_wp7"); sysObj.save();
DfException
- if a server error occursvoid revert() throws DfException
DfException
- if a server error occursvoid destroy() throws DfException
IDfPersistentObject perObj = sess.getObject(new DfId("0900d5bb8001f900")); perObj.destroy();
DfException
- if a server error occurs,IDfSysObject.destroyAllVersions()
,
IDfSysObject.prune(boolean)
void lock() throws DfException
DfException
void lockEx(boolean validateStamp) throws DfException
validateStamp
- DfException
void signoff(java.lang.String user, java.lang.String os_password, java.lang.String reason) throws DfException
user
- identifies the signer. Specify the user_os_name.os_password
- specifies the user’s operating system password.reason
- describes the purpose for which the signature is issued.DfException
- if server error occursIDfRelation addChildRelative(java.lang.String relationTypeName, IDfId childId, java.lang.String childLabel, boolean isPermanent, java.lang.String description) throws DfException
relationTypeName
- the name of a valid relation typechildId
- child of this RelationchildLabel
- version string of the child. If this is null
, the relation will
contain no child label.isPermanent
- is the link permanent.description
- a user-friendly description for the relation object. If null
, the
relation object will not have a description.DfException
- if a server error occursIDfRelation addParentRelative(java.lang.String relationTypeName, IDfId parentId, java.lang.String childLabel, boolean isPermanent, java.lang.String description) throws DfException
relationTypeName
- the name of a valid relation typeparentId
- parent of this childchildLabel
- version string of the child. If this is null
, the relation will
contain no child label.isPermanent
- is the link permanent.description
- a user-friendly description for the relation object. If null
, the
relation object will not have a description.DfException
- if a server error occursIDfRelation
IDfCollection getChildRelatives(java.lang.String relationTypeName) throws DfException
relationTypeName
- name of the relation typeDfException
- if a server error occursIDfCollection getParentRelatives(java.lang.String relationTypeName) throws DfException
relationTypeName
- name of the relation typeDfException
- if a server error occursvoid removeChildRelative(java.lang.String relationTypeName, IDfId childId, java.lang.String childLabel) throws DfException
null
as the value for either childId
, or childLabel
, or
both. For example, if both childId
and childLabel
are null
, all
relation objects where the relation type is relationTypeName
and the parent is this object
will be removed.relationTypeName
- - name of the relation.childId
- - child of this object.childLabel
- - version string of the child.DfException
- if a server error occursvoid removeParentRelative(java.lang.String relationTypeName, IDfId parentId, java.lang.String childLabel) throws DfException
null
as the value for either
parentId
, or childLabel
, or both. For example, if both parentId
and childLabel
are null
, all relation objects where the relation type is
relationTypeName
and this object is the child and where the child label
equalschildLabel
, will be deleted.relationTypeName
- name of the relation.parentId
- parent of this object.childLabel
- version string of the child.DfException
- if a server error occursjava.lang.String apiGet(java.lang.String cmd, java.lang.String args) throws DfException
dmAPIGet
calls.
Application developers are encouraged to write to the DFC since all functionality in the server APIs
can be accessed through these classes. Since apiGet
automatically inserts the session ID
and object ID into calls made to this method, do not add these two arguments to server API calls that
require them. For example, if you are passing the get
server API to the DFC, you would
write the following code:
mypersistobj.apiGet('get', 'object_name')
instead of writing
dmAPIGet('get,c,090007d080001234,object_name')
where 090007d080001234 is the object ID of mypersistobj
.cmd
- the server APIargs
- the arguments for the API specified in cmd
. (This does not include the session
ID or object ID.) Refer to the API Reference Manual for more information about
arguments for server APIs.cmd
; Refer to the Server Reference
Manual for more information about the return values for server APIs.DfException
- if the dmAPISet
server API failed, or the current session has timed
out and cannot be re-establishedapiSet(java.lang.String, java.lang.String, java.lang.String)
,
apiExec(java.lang.String, java.lang.String)
boolean apiSet(java.lang.String cmd, java.lang.String args, java.lang.String value) throws DfException
dmAPISet
calls.
Application developers are encouraged to write to the DFC since all functionality in the server APIs
can be accessed through these classes. Since apiSet
automatically inserts the session ID
and object ID into calls made to this method, do not add these two arguments to server API calls that
require them. For example, if you are passing the set
server API to the DFC, you would
write the following code:
mypersistobj.apiSet('set', 'object_name, my_name')
instead of writing
dmAPISet('set,c,090007d080001234,object_name,my_name')
where 090007d080001234 is the object ID of mypersistobj
.cmd
- the server APIargs
- the arguments for the API specified in cmd
; Refer to the Server Reference
Manual for more information about arguments for server APIs.value
- the value that you want to assign to the attributetrue
is always returned.DfException
- if the dmAPISet
server API failed, or the current session has timed
out and cannot be reestablishedapiGet(java.lang.String, java.lang.String)
,
apiExec(java.lang.String, java.lang.String)
boolean apiExec(java.lang.String cmd, java.lang.String args) throws DfException
dmAPIExec
calls.
Application developers are encouraged to write to the DFC since all functionality in the server APIs
can be accessed through these classes.
Refer to the Server Reference Manual for more information about DMCL server APIs.cmd
- the server APIargs
- the arguments for the API specified in cmd
(this does not include the session
ID or the object ID).true
is always returned.DfException
- if the dmAPISet
server API failed, or the current session has timed
out and cannot be reestablishedapiGet(java.lang.String, java.lang.String)
,
apiSet(java.lang.String, java.lang.String, java.lang.String)
IDfList getAttrAssistance(java.lang.String attrName) throws DfException
attrName
- the attribute to get the value assistance forDfException
IDfList getAttrAssistanceWithValues(java.lang.String attrName, IDfList depAttrNameList, IDfList depAttrValueListList) throws DfException
DfException
- if a server error occursIDfList getAttrAsstDependencies(java.lang.String attrName) throws DfException
attrName
- the attribute to get the dependencies forDfException
java.lang.String getWidgetType(int environment, java.lang.String attrName) throws DfException
DfException
void validateAllRules(int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void validateAttrRules(java.lang.String attrName, int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void validateAttrRulesWithValue(java.lang.String attrName, java.lang.String value, int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void validateAttrRulesWithValues(java.lang.String attrName, IDfList valueList, int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void validateObjRules(int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void validateObjRulesWithValues(IDfList attrNameList, IDfList valueListList, int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- specified the maximum number of validation rules violation
validateAllRules() will detect. If "stopAfterNumOfErrors" is set to zero,
validateAllRules() will not stop until it completes all the validation
rules.DfException
void setPartition(int partition) throws DfException
DfException
- if a server error occursint getPartition() throws DfException
DfException
- if a server error occursvoid registerEvent(java.lang.String message, java.lang.String event, int priority, boolean sendMail) throws DfException
message
- Defines a message sent to the user
receiving the event notification.event
- Defines the event for which you want
to receive notification.priority
- Defines a priority level for the event.
Use an integer number for this argument.sendMail
- Directs the server to send electronic mail
to the user whenever an event is placed on
the user's queue.DfException
- if a server error occurs.void unRegisterEvent(java.lang.String event) throws DfException
event
- Identifies the event whose registration you want
to cancel.DfException
- if a server error occurs.void unRegisterEventEx(java.lang.String event, java.lang.String userName) throws DfException
event
- Identifies the event whose registration you want
to cancel.userName
- User who initially registered the event. This is used by a user with SysAdmin or
SuperUser privilege to unregister an event previously registered by another user.DfException
- if a server error occurs.Copyright 1994-2023 OpenText Corporation. All rights reserved.