# Uses of Interface
com.documentum.fc.common.IDfTime

Packages that use IDfTime
Package
Description
com.documentum.com
Provides an interface for accessing the DFC through OLE/COM.
com.documentum.fc.bpm
com.documentum.fc.client
com.documentum.fc.client.content
com.documentum.fc.client.dcis.model
com.documentum.fc.client.mq
com.documentum.fc.client.search
Provides classes and interfaces for constructing and running search queries against multiple content repositories as well as external information sources (optional).
com.documentum.fc.common
Provides classes and interfaces to utility functionality associated with all DFC objects.

- ## Uses of IDfTime in com.documentum.com

  Methods in com.documentum.com that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  DfClientX.`getTime(String time, String pattern)`
  `IDfTime`
  IDfClientX.`getTime(String time, String pattern)`
  Factory method for an `IDfTime` object.

- ## Uses of IDfTime in com.documentum.fc.bpm

  Methods in com.documentum.fc.bpm with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `void`
  IDfAttributeValueCondition.`setTimeValue(IDfTime value)`
  Sets a time value for use within the comparison.

- ## Uses of IDfTime in com.documentum.fc.client

  Methods in com.documentum.fc.client that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  IDfPackage.`getAcceptanceDate()`
  Returns the acceptance date, which identifies when a package arrived and was accepted by an input port.
  `IDfTime`
  IDfSysObject.`getAccessDate()`
  Returns the date the content of this object was last accessed.
  `IDfTime`
  IDfQueueItem.`getActualStartDate()`
  Returns the date on which work on the item actually started.
  `IDfTime`
  IDfSysObject.`getCreationDate()`
  Returns the r_creation_date attribute of the object.
  `IDfTime`
  IDfWorkflowAttachment.`getCreationDate()`
  Returns the r_creation_date attribute of the object.
  `IDfTime`
  IDfWorkitem.`getCreationDate()`
  Returns the date on which the work item was created.
  `IDfTime`
  IDfQueueItem.`getDateSent()`
  Returns the date the work item, task, or event was sent.
  `IDfTime`
  IDfQueueItem.`getDequeuedDate()`
  Returns the date on which the item was dequeued.
  `IDfTime`
  IDfQueueItem.`getDueDate()`
  Returns the date on which the associated work item or task is expected to be completed.
  `IDfTime`
  IDfWorkitem.`getDueDate()`
  Returns the work item's due date.
  `IDfTime`
  IDfRelation.`getEffectiveDate()`
  Not system defined.
  `IDfTime`
  IDfDumpRecord.`getEndTime()`
  `IDfTime`
  IDfLoadRecord.`getEndTime()`
  `IDfTime`
  IDfRelation.`getExpirationDate()`
  Not system defined.
  `IDfTime`
  IDfServerMap.`getLastCheckpoint(int index)`
  Returns the time that the server last reported to the connection broker.
  `IDfTime`
  IDfWorkitem.`getLaunchTimeout()`
  Returns the launch timeout value of this work item.
  `IDfTime`
  IDfSysObject.`getLockDate()`
  Returns the date this object was locked.
  `IDfTime`
  IDfGroup.`getModifyDate()`
  Returns the time and date that a group object was last modified.
  `IDfTime`
  IDfSysObject.`getModifyDate()`
  Returns the r_modify_date attribute of the object.
  `IDfTime`
  IDfUser.`getModifyDate()`
  Returns the time and date that a user was last modified.
  `IDfTime`
  IDfServerMap.`getNextCheckpoint(int index)`
  Returns the time that the server is next expected to report to the connection broker.
  `IDfTime`
  IDfPackage.`getNoteCreationDate(int noteIndex)`
  Returns an IDfTime interface which contains the creation date of the specified note.
  `IDfTime`
  IDfQueueItem.`getPlanStartDate()`
  Returns the expected starting date of the associated router task.
  `IDfTime`
  IDfWorkflow.`getPostTimer(int valueIndex)`
  Returns the post-timer value for an activity.
  `IDfTime`
  IDfWorkflow.`getPreTimer(int valueIndex)`
  Returns the pre-timer value for an activity.
  `IDfTime`
  IDfTypedObject.`getRepeatingTime(String attributeName, int valueIndex)`
  Returns a date/time value stored in a repeating attribute.
  `IDfTime`
  IDfSysObject.`getRetainUntilDate()`
  Returns the retain until date for this object.
  `IDfTime`
  IDfRetainer.`getRetentionDate()`
  Returns the dm_retainer.retention_date value.
  `IDfTime`
  IDfSysObject.`getRetentionDate()`
  Used internally.
  `IDfTime`
  IDfQueueItem.`getSignOffDate()`
  Returns the date on which the work item or task was signed off.
  `IDfTime`
  IDfWorkflow.`getStartDate()`
  Returns the start date of the workflow.
  `IDfTime`
  IDfDumpRecord.`getStartTime()`
  `IDfTime`
  IDfLoadRecord.`getStartTime()`
  `IDfTime`
  IDfTypedObject.`getTime(String attributeName)`
  Returns the date/time value of an attribute.
  `IDfTime`
  IDfSysObject.`getTimeContentAttr(String name, String formatName, int page, String pageModifier)`
  Return a time content attribute.
  Methods in com.documentum.fc.client with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `void`
  IDfTypedObject.`appendTime(String attributeName, IDfTime value)`
  Appends a date/time value to a repeating attribute.
  `IDfId`
  IDfSession.`archive(String predicate, String operatorName, int priority, boolean sendMail, IDfTime dueDate)`
  Queues an archive request to the repository operator.
  `void`
  IDfSysObject.`cancelScheduledDemote(IDfTime scheduleDate)`
  This will cancel the scheduled demote of the sysobject at the date/time specifed by `scheduleDate`.
  `void`
  IDfSysObject.`cancelScheduledPromote(IDfTime scheduleDate)`
  This will cancel the scheduled promote for the date/time specified in the `scheduleDate` argument.
  `void`
  IDfSysObject.`cancelScheduledResume(IDfTime schedule)`
  This will cancel a scheduled resume of the sysobject for a certain date/time.
  `void`
  IDfSysObject.`cancelScheduledSuspend(IDfTime scheduleDate)`
  This method can be used to cancel a scheduled suspend of the sysobject at a date/time.
  `int`
  IDfTypedObject.`findTime(String attributeName, IDfTime value)`
  Searches through the values in a repeating attribute and returns the index of the first value that matches the specified date/time value.
  `void`
  IDfTypedObject.`insertTime(String attributeName, int valueIndex, IDfTime value)`
  Inserts a date/time value into a repeating attribute.
  `IDfId`
  IDfSysObject.`queue(String queueOwner, String event, int priority, boolean sendMail, IDfTime dueDate, String message)`
  Places the object on a specified queue.
  `IDfId`
  IDfWorkflow.`queue(String supervisor, String eventType, int priority, boolean sendMail, IDfTime dueDate, String message)`
  Sends an event to a workflow.
  `IDfId`
  IDfWorkitem.`queue(String user, String eventType, int priority, boolean sendMail, IDfTime dueDate, String message)`
  Sends an event to a workitem.
  `IDfId`
  IDfSession.`restore(String predicate, String dumpFile, String operatorName, int priority, boolean sendMail, IDfTime dueDate)`
  Queues a request to restore a content file or files from the archives.
  `void`
  IDfSysObject.`scheduleDemote(String state, IDfTime schedule_date)`
  Schedules the sysobject to demote from its current normal state to the state defined in the `state` parameter.
  `void`
  IDfSysObject.`schedulePromote(String state, IDfTime scheduleDate, boolean override)`
  Schedules a sysobject to be promoted to the next state on a particular date/time specified by the `scheduleDate` parameter.
  `void`
  IDfSysObject.`scheduleResume(String state, IDfTime scheduleDate, boolean toBase, boolean override)`
  Schedules to resume the sysobject from an exception state to the next state at the specified date/time.
  `void`
  IDfSysObject.`scheduleSuspend(String state, IDfTime scheduleDate, boolean override)`
  Schedule a suspend of the sysobject from its current state to the exception state at a certain date/time.
  `void`
  IDfRetainer.`setDateRetentionPeriod(IDfTime retentionDate)`
  Specifies the retention period for the retainer.
  `void`
  IDfRelation.`setEffectiveDate(IDfTime date)`
  Not system defined.
  `void`
  IDfRelation.`setExpirationDate(IDfTime date)`
  Not system defined.
  `void`
  IDfTypedObject.`setRepeatingTime(String attributeName, int valueIndex, IDfTime value)`
  Sets a date/time value of a repeating attribute.
  `void`
  IDfTypedObject.`setTime(String attributeName, IDfTime value)`
  Sets the date/time value of an attribute.
  `void`
  IDfSysObject.`setTimeContentAttribute(String name, IDfTime value, String formatName, int page, String pageModifier)`
  Set a Date/Time content attribute.

- ## Uses of IDfTime in com.documentum.fc.client.content

  Methods in com.documentum.fc.client.content that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  IDfCAStore.`getDefaultRetentionDate()`
  `IDfTime`
  IDfContent.`getIndexSetTimes(int index)`
  `IDfTime`
  IDfContent.`getSetTime()`
  `IDfTime`
  IDfContent.`getTimeContentAttr(int index)`
  Methods in com.documentum.fc.client.content with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `void`
  IDfCAStore.`setDefaultRetentionDate(IDfTime value)`

- ## Uses of IDfTime in com.documentum.fc.client.dcis.model

  Methods in com.documentum.fc.client.dcis.model that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  CSAIConfig.`getLlmModifiedDate()`
  Methods in com.documentum.fc.client.dcis.model with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `void`
  CSAIConfig.`setLlmModifiedDate(IDfTime llmModifiedDate)`

- ## Uses of IDfTime in com.documentum.fc.client.mq

  Methods in com.documentum.fc.client.mq that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  IDfMessage.`getCreationTime()`
  Returns the message reation time.
  `IDfTime`
  IDfMessage.`getExpirationTime()`
  Returns the message expiration time.
  `IDfTime`
  IDfMessage.`getUpdateTime()`
  Returns the last state change time of the message.
  Methods in com.documentum.fc.client.mq with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `void`
  IDfMessage.`setCreationTime(IDfTime time)`
  Sets the message creation time.
  `void`
  IDfMessage.`setExpirationTime(IDfTime expirationTime)`
  Sets the message expiration time.
  `void`
  IDfMessage.`setUpdateTime(IDfTime time)`
  Sets the message state update time.

- ## Uses of IDfTime in com.documentum.fc.client.search

  Methods in com.documentum.fc.client.search that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  IDfResultEntry.`getRepeatingTime(String attrName, int valueIndex)`
  Returns the time value stored in a repeating attribute, located at a specific index.
  `IDfTime`
  IDfResultEntry.`getTime(String attrName)`
  Returns the time value stored in a specific attribute.
  Methods in com.documentum.fc.client.search with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `int`
  IDfResultEntry.`findTime(String attrName, IDfTime value)`
  Searches through the values in a repeating attribute and returns the first index value that corresponds to the specified time value.

- ## Uses of IDfTime in com.documentum.fc.common

  Classes in com.documentum.fc.common that implement IDfTime
  Modifier and Type
  Class
  Description
  `final class`
  `DfTime`
  An implementation of the IDfTime interface.
  Methods in com.documentum.fc.common that return IDfTime
  Modifier and Type
  Method
  Description
  `IDfTime`
  IDfValue.`asTime()`
  Returns the contents of a value object as an `IDfTime` interface.
  `IDfTime`
  IDfList.`getTime(int index)`
  Fetches an instance of an IDfTime object from the list at the specified index.
  `IDfTime`
  IDfProperties.`getTime(String propertyName)`
  Returns an IDfTime interface to which the specified property name is mapped to in the object.
  Methods in com.documentum.fc.common with parameters of type IDfTime
  Modifier and Type
  Method
  Description
  `int`
  IDfList.`appendTime(IDfTime value)`
  Appends an instance of an IDfTime object to the list.
  `int`
  DfTime.`compareTo(IDfTime object)`
  `int`
  IDfTime.`compareTo(IDfTime time)`
  Returns 1 if this date/time is later than the argument "time"; 0 if the two date/times are the same; or -1 if this date/time object represents an older time than the argument.
  `int`
  IDfList.`findTimeIndex(IDfTime value)`
  Returns the index of the first occurrence of an IDfTime object in the list.
  `void`
  IDfList.`insertTime(int index, IDfTime value)`
  Inserts an instance of an IDfTime object into the list at a specified index.
  `void`
  IDfProperties.`putTime(String propertyName, IDfTime propertyValue)`
  Maps the specified property name to the specified IDfTime interface property value.
  `void`
  IDfList.`setTime(int index, IDfTime value)`
  Adds an instance of an IDfTime interface into the list at a specified index.