All Frameworks  Class Hierarchy  This Framework  Indexes   

System Interface CATISysDisconnectionSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISysDisconnectionSettingAtt

Interface to handle the parameters of automatic disconnection.
Role: This interface is implemented by a component which represents the controller of the cache.
This interface defines:


Method Index


o GetActivationStateInfo(CATSettingInfo*)
Retrieves informations about the activation mode of automatic disconnection.
o GetActivationState(CATBoolean*)
Returns activation state of automatic disconnection.
o GetInactivityDurationInfo(CATSettingInfo*)
Retrieves environment informations for inactivity duration.
o GetInactivityDuration(int*)
Returns or sets the inactivity duration.
o PutActivationState(CATBoolean)
Turns ON/OFF the automatic disconnection.
o PutInactivityDuration(int)
Sets the inactivity duration.
o SetActivationStateLock(unsigned char)
Locks or unlocks the activation mode of automatic disconnection.
o SetInactivityDurationLock(unsigned char)
Locks or unlocks the inactivity duration.

Methods


o GetActivationStateInfo
public virtual GetActivationStateInfo( oInfo)
Retrieves informations about the activation mode of automatic disconnection.
Refer to CATSysSettingController for a detailled description.
o GetActivationState
public virtual GetActivationState( oActivationState)
Returns activation state of automatic disconnection.
Role:Returns or sets the activation mode of automatic disconnection.
Parameters:
oMode
Legal values:
FALSE: turned off
TRUE: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInactivityDurationInfo
public virtual GetInactivityDurationInfo( oInfo)
Retrieves environment informations for inactivity duration.
Refer to CATSysSettingController for a detailled description.
o GetInactivityDuration
public virtual GetInactivityDuration( oMaxInactivity)
Returns or sets the inactivity duration.
Role: Returns the timeout in seconds before the automatic disconnection when no activity has been detected, if the mechanism is enabled.
Parameters:
oMaxInactivity
The inactivity duration in seconds.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o PutActivationState
public virtual PutActivationState( iActivationState)
Turns ON/OFF the automatic disconnection.
Role: Activates or desactivates the cache mechanism.
Parameters:
iMode
Legal values:
FALSE: to turn off
TRUE: to turn on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o PutInactivityDuration
public virtual PutInactivityDuration( iMaxInactivity)
Sets the inactivity duration.
Role: Sets the timeout in seconds before the automatic disconnection when no activity has been detected, if the mechanism is enabled.
Parameters:
iMaxInactivity
The inactivity duration in second.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetActivationStateLock
public virtual SetActivationStateLock( iLock)
Locks or unlocks the activation mode of automatic disconnection.
Refer to CATSysSettingController for a detailled description.
o SetInactivityDurationLock
public virtual SetInactivityDurationLock( iLock)
Locks or unlocks the inactivity duration.
Refer to CATSysSettingController for a detailled description.

This object is included in the file: CATISysDisconnectionSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP

Copyright © 2003, Dassault Systèmes. All rights reserved.