com.ibm.mm.sdk.common

Interface dkOracleTextIndexICM.UpdateFrequency

Enclosing interface:
dkOracleTextIndexICM
  1. public static interface dkOracleTextIndexICM.UpdateFrequency
Represents information on the automatic updating of a text index. When an update frequency is set for a text index the Library Server will automatically update the index at the specified interval.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
 interval()
Returns the interval that the index is automatically updated.
  1. void
 interval(java.lang.String interval)
Specifies the interval that the text index is to be automatically updated.
  1. dkOracleTextIndexICM.Memory
 memory()
Returns the currently set Memory for the UpdateFrequency.
  1. void
 memory(dkOracleTextIndexICM.Memory mem)
Specifies the Memory that is to be used when updating the index.
  1. dkOracleTextIndexICM.ParallelDegree
 parallel()
Returns the currently set ParallelDegree.
  1. void
 parallel(dkOracleTextIndexICM.ParallelDegree parallel)
Specifies the ParallelDegree that is to be used when updating the index.

Method Detail

interval

  1. void interval(java.lang.String interval)
  2. throws DKInvalidParameterException
Specifies the interval that the text index is to be automatically updated.
Parameters:
interval - The interval that the index is to be automatically updated. Note: The syntax of the interval is only validated by the library server when the index (or changes) are make persistent.
Throws:
DKInvalidParameterException - Thrown when a null String is passed in as the interval, or if the length of the string is greater than the maximum length of an option.

interval

  1. java.lang.String interval()
Returns the interval that the index is automatically updated.
Returns:
The interval that the index is automatically updated.

parallel

  1. void parallel(dkOracleTextIndexICM.ParallelDegree parallel)
Specifies the ParallelDegree that is to be used when updating the index.
Parameters:
parallel - The ParallelDegree to use when updating the index, or null to remove the setting and use the Oracle default setting.

parallel

  1. dkOracleTextIndexICM.ParallelDegree parallel( )
Returns the currently set ParallelDegree.
Returns:
The currently set ParallelDegree for the UpdateFrequency, or null if it is not set.

memory

  1. void memory(dkOracleTextIndexICM.Memory mem)
Specifies the Memory that is to be used when updating the index.
Parameters:
mem - The Memory to use when updating the index, or null to remove the setting and use the Oracle default setting.

memory

  1. dkOracleTextIndexICM.Memory memory( )
Returns the currently set Memory for the UpdateFrequency.
Returns:
The currently set ParallelDegree for the UpdateFrequency, or null if it is not set.