public interface IDfService extends IDfModule
IDfService
interface as well as implement
this IDfService
interface in order to provide some common
functionality for all services.DfService
Modifier and Type | Method and Description |
---|---|
void |
cleanupResources()
Provides to the service client an opportunity to release some
service specific resources before the Java garbage collector will
collect the object.
|
java.lang.String |
getName()
Returns the fully qualified logical name of the service interface.
|
IDfSession |
getSession(java.lang.String docbase)
Returns a previously established "managed"
IDfSession
object. |
IDfSessionManager |
getSessionManager()
Allows a service to obtain the its session manager handle.
|
java.lang.String |
getVendorString()
Gets the Copyright statement string.
|
java.lang.String |
getVersion()
Gets the current version of the service as a string.
|
boolean |
isCompatible(java.lang.String version)
Checks if this object is compatible with the specified version,
often used in conjunction with the
supportsFeature
method. |
void |
releaseSession(IDfSession session)
Releases the "managed" session back to the session pool.
|
boolean |
supportsFeature(java.lang.String feature)
Checks if the specified feature matches an entry in the implementations
list of supported features.
|
java.lang.String getName()
"com.documentum.services.inbox.IInbox"
java.lang.String getVersion()
<major version>.<minor
version>
. Example: "1.0"
.isCompatible(java.lang.String)
,
supportsFeature(java.lang.String)
java.lang.String getVendorString()
If a service is provided by Documentum the vendor string would be "Copyright (c) Documentum, Inc. 2002. All Rights reserved.".
boolean isCompatible(java.lang.String version)
supportsFeature
method.
An example might be, isCompatible( "1.2" );
version
- version string of format: <major
version>.<minor version>
. Example:
"1.0"
true
if service is compatible with the version
(false
if incompatible)boolean supportsFeature(java.lang.String feature)
Hashtable
, array,
IDfList
, etc. Based on this information, specific UI
features might then be switched on or off.
Based on this feature information, a program can make decisions on
how to use the object, for example, certain UI features can then be
switched on or off. For instance, a search service may not support
an external search or full text search.
supportsFeature( "fulltextsearch" );
feature
- feature stringfalse
if the
feature is not supported)IDfSessionManager getSessionManager()
"DfService"
class.IDfSessionManager
IDfSession getSession(java.lang.String docbase) throws DfServiceException
IDfSession
object. Each time this method is called a corresponding
releaseSession
method must be called.
Calling this method before releasing the session is not an error. It merely
returns the IDfSession
object reference again.
docbase
- repository nameIDfSession
object, either from the session pool
or one that has not yet returned to the session pool.DfServiceException
void releaseSession(IDfSession session) throws DfServiceException
getSession()
.session
- an IDfSession
object that was obtained from
the session manager.DfServiceException
- Internal errorvoid cleanupResources() throws DfServiceException
DfServiceException
- Internal errorCopyright 1994-2023 OpenText Corporation. All rights reserved.