Content Engine Java API: CmTimeslot

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

DependentObject, EngineObject, java.io.Serializable
```
public interface CmTimeslot
extends EngineObject, DependentObject
```
Defines a schedule for a text-indexing, audit-disposition, or sweep-job background task. CmTimeslot specifies when the task will start and how long it will run.
You create a CmTimeslot object with a Factory method, and set its weekday, start time, and duration properties. The day and times that you set are interpreted relative to the server's local time, not Coordinated Universal Time (UTC).

You add CmTimeslot objects to a CmTimeslotList, which you set on a CmTextSearchConfiguration, CmAuditingConfiguration, CmSweepConfiguration, or CmSweep object. Note that the times of multiple timeslots might overlap, in which case the overlapping timeslots are effectively combined.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject

See Also:
Content-Based Retrieval Concepts, Audit Disposition, Thumbnail Concepts, Disposal Policy Concepts

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`get_Duration()` Returns the value of the Duration property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Integer`	`get_StartMinutesPastMidnight()` Returns the value of the StartMinutesPastMidnight property.
`Weekday`	`get_Weekday()` Returns the value of the Weekday property.
`void`	`set_Duration(java.lang.Integer value)` Sets the value of the Duration property.
`void`	`set_StartMinutesPastMidnight(java.lang.Integer value)` Sets the value of the StartMinutesPastMidnight property.
`void`	`set_Weekday(Weekday value)` Sets the value of the Weekday property.

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Weekday
```
Weekday get_Weekday()
```
    Returns the value of the Weekday property. For more information, see Weekday Property.
  - set_Weekday
```
void set_Weekday(Weekday value)
```
    Sets the value of the Weekday property. For more information, see Weekday Property.
  - get_StartMinutesPastMidnight
```
java.lang.Integer get_StartMinutesPastMidnight()
```
    Returns the value of the StartMinutesPastMidnight property. For more information, see StartMinutesPastMidnight Property.
  - set_StartMinutesPastMidnight
```
void set_StartMinutesPastMidnight(java.lang.Integer value)
```
    Sets the value of the StartMinutesPastMidnight property. For more information, see StartMinutesPastMidnight Property.
  - get_Duration
```
java.lang.Integer get_Duration()
```
    Returns the value of the Duration property. For more information, see Duration Property.
  - set_Duration
```
void set_Duration(java.lang.Integer value)
```
    Sets the value of the Duration property. For more information, see Duration Property.