com.filenet.api.constants
Class ContentAccessRecordingLevel

java.lang.Object
  extended by com.filenet.api.constants.ContentAccessRecordingLevel
All Implemented Interfaces:
java.io.Serializable

public final class ContentAccessRecordingLevel
extends java.lang.Object
implements java.io.Serializable

Specifies options for the recording granularity of updates to the DateContentLastAccessed property when content is accessed.

Note: Whenever content access recording is enabled, system performance might be impacted. The impact increases as you increase recording frequency. For more information, see ContentAccessRecordingLevel Property.

See Also:
Serialized Form

Field Summary
static ContentAccessRecordingLevel DAILY
          Specifies that the DateContentLastAccessed property will be updated only when a day (86400 seconds) has elapsed since the last update of the DateContentLastAccessed property.
static int DAILY_AS_INT
          An int value associated with the DAILY instance of this class.
static ContentAccessRecordingLevel HOURLY
          Specifies that the DateContentLastAccessed property will be updated only when an hour (3600 seconds) has elapsed since the last update of the DateContentLastAccessed property.
static int HOURLY_AS_INT
          An int value associated with the HOURLY instance of this class.
static ContentAccessRecordingLevel IMMEDIATE
          Specifies that the DateContentLastAccessed property will be updated as soon as content is accessed.
static int IMMEDIATE_AS_INT
          An int value associated with the IMMEDIATE instance of this class.
static ContentAccessRecordingLevel NONE
          Specifies that updates to the DateContentLastAccessed property are disabled (which is the default behavior).
static int NONE_AS_INT
          An int value associated with the NONE instance of this class.
 
Method Summary
static ContentAccessRecordingLevel getInstanceFromInt(int value)
          Returns an instance of this class using its associated integer value.
 int getValue()
          Returns the internal integer value associated with a specific instance of this class.
 java.lang.String toString()
          Returns a String representation of this enumeration instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DAILY_AS_INT

public static final int DAILY_AS_INT
An int value associated with the DAILY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DAILY

public static final ContentAccessRecordingLevel DAILY
Specifies that the DateContentLastAccessed property will be updated only when a day (86400 seconds) has elapsed since the last update of the DateContentLastAccessed property. Any access of content within a day of the last update will not be recorded.


HOURLY_AS_INT

public static final int HOURLY_AS_INT
An int value associated with the HOURLY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

HOURLY

public static final ContentAccessRecordingLevel HOURLY
Specifies that the DateContentLastAccessed property will be updated only when an hour (3600 seconds) has elapsed since the last update of the DateContentLastAccessed property. Any access of content within an hour of the last update will not be recorded.


IMMEDIATE_AS_INT

public static final int IMMEDIATE_AS_INT
An int value associated with the IMMEDIATE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

IMMEDIATE

public static final ContentAccessRecordingLevel IMMEDIATE
Specifies that the DateContentLastAccessed property will be updated as soon as content is accessed. The value of this constant is 0 seconds.


NONE_AS_INT

public static final int NONE_AS_INT
An int value associated with the NONE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

NONE

public static final ContentAccessRecordingLevel NONE
Specifies that updates to the DateContentLastAccessed property are disabled (which is the default behavior). The value of this constant, -1, is used as a special indicator and does not represent an amount of time.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static ContentAccessRecordingLevel getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


© Copyright IBM Corporation 2006, 2009. All rights reserved.