# Uses of Interface
com.documentum.fc.client.IDfCollection

Packages that use IDfCollection
Package
Description
com.documentum.fc.client
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).

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

  Subinterfaces of IDfCollection in com.documentum.fc.client
  Modifier and Type
  Interface
  Description
  `interface`
  `IDfContentCollection`
  Methods in com.documentum.fc.client that return IDfCollection
  Modifier and Type
  Method
  Description
  `IDfCollection`
  IDfSession.`apply(String objId, String functionName, IDfList args, IDfList dataType, IDfList values)`
  Calls the server API Apply method.
  `IDfCollection`
  IDfSysObject.`assemble(IDfId virtualDocId, int interruptFreq, String qualification, String nodesortList)`
  Creates an assembly and associates it with the object.
  `IDfCollection`
  IDfSession.`collectMetrics(List<String> metricsToCollect)`
  This methods indicates to the server to collect the metrics that have been passed in to this method.
  `IDfCollection`
  IDfSession.`collectMetrics(List<String> metricsToCollect, String outputFormat)`
  This methods indicates to the server to collect the metrics that have been passed in to this method.
  `IDfCollection`
  IDfQuery.`execute(IDfSession session, int queryType)`
  Executes a DQL query.
  `IDfCollection`
  IDfWorkitem.`getAllPackages(String additionalAttributes)`
  Returns a query result collection containing the following attributes: String documentIDs object ID's of documents, separated by commas String r_package_name String r_packageType String i_package_oprtn IDfId r_note_id
  `IDfCollection`
  IDfWorkflow.`getAttachments()`
  Returns a list of all the workflow's attachments.
  `IDfCollection`
  IDfWorkitem.`getAttachments()`
  Returns a list of all the workflow's attachments.
  `IDfCollection`
  IDfPersistentObject.`getChildRelatives(String relationTypeName)`
  Returns a collection of IDfRelation objects where parent is this object, and the relation_name matches the value passed in as a parameter.
  `IDfCollection`
  IDfSysObject.`getCollectionForContent(String format, int pageNumber)`
  Returns a collection containing the object's content in the repository.
  `IDfCollection`
  IDfSysObject.`getCollectionForContentEx2(String format, int pageNumber, String pageModifier)`
  Returns a collection containing the object's content in the repository.
  `IDfCollection`
  IDfSysObject.`getCollectionForContentEx3(String format, int pageNumber, String pageModifier, boolean other)`
  Returns a collection containing the object's content in the repository.
  `IDfCollection`
  IDfFolder.`getContents(String attrNames)`
  Returns the values of specified attributes for all objects in a folder object.
  `IDfCollection`
  IDfSession.`getEvents()`
  Returns all unread items in a user's inbox.
  `IDfCollection`
  IDfGroup.`getGroupsNames()`
  Returns a collection of group members' names in this group.
  `IDfCollection`
  IDfSession.`getLastCollection()`
  Returns the collection object for the most recently executed query.
  `IDfCollection`
  IDfSysObject.`getLocations(String attrNames)`
  Runs a query to find all the places this object is used and returns the query result as a collection.
  `IDfCollection`
  IDfWorkitem.`getMissingOutputPackages()`
  Returns a collection whose result objects describe all output ports in the work item that don't have a package.
  `IDfCollection`
  IDfWorkitem.`getPackages(String additionalAttributes)`
  Returns a list of all the work item's packages.
  `IDfCollection`
  IDfActivity.`getPackagesMetaData()`
  Returns a query result collection containing the following attributes:
  `IDfCollection`
  IDfPersistentObject.`getParentRelatives(String relationTypeName)`
  Returns a collection of IDfRelation objects where child is this object, and the relation_name matches the value passed in as a parameter.
  `IDfCollection`
  IDfSysObject.`getRenditions(String attrNames)`
  Runs a query against the dmr_content table to return values for all the page 0 content for this object.
  `IDfCollection`
  IDfSysObject.`getRouters(String additionalAttributes, String orderBy)`
  Returns a collection of routers the document participates in.
  `IDfCollection`
  IDfSession.`getRunnableProcesses(String additionalAttributes)`
  Returns a collection that contains the object ID and attribute values of all installed dm_process objects in a repository.
  `IDfCollection`
  IDfSession.`getTasks(String userName, int filter, String additionalAttributes, String orderBy)`
  Retrieves the work items assigned to the specified user.
  `IDfCollection`
  IDfSession.`getTasksEx(String userName, int filter, IDfList orderByList, IDfList ascendingList)`
  Retrieves the work items assigned to the specified user.
  `IDfCollection`
  IDfGroup.`getUsersNames()`
  Returns a collection of user members' names in this group.
  `IDfCollection`
  IDfSysObject.`getVdmPath(IDfId rootId, boolean shortestPath, String versionList)`
  Returns the path or paths through a virtual document that lead to a particular component.
  `IDfCollection`
  IDfSysObject.`getVdmPathDQL(IDfId rootId, boolean shortestPath, String parentType, String bindingLabel, String nodeSortBy)`
  Returns the path or paths through a virtual document that lead to a particular component.
  `IDfCollection`
  IDfSysObject.`getVersions(String attrNames)`
  Runs a query to find all the versions of the object and returns the query results as a collection.
  `IDfCollection`
  IDfSysObject.`getWorkflows(String additionalAttributes, String orderBy)`
  Returns a collection of workflows the document currently participates in.
  `IDfCollection`
  IDfSession.`listMetricsState()`
  Retrieves the state of all the metrics that are gatherable from the server.
  `IDfCollection`
  IDfSession.`startGatheringMetrics(List<String> metricsToGather)`
  This methods indicates to the server to start gathering the metrics that have been passed in to this method.
  `IDfCollection`
  IDfSession.`stopGatheringMetrics(List<String> metricsToStop)`
  This methods indicates to the server to stop gathering the metrics that have been passed in to this method.

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

  Methods in com.documentum.fc.client.search that return IDfCollection
  Modifier and Type
  Method
  Description
  `IDfCollection`
  IDfSearchStoreService.`getAllSearches()`
  Deprecated.
  Use getAllSearches(IDfSession) instead
  `IDfCollection`
  IDfSearchStoreService.`getAllSearches(IDfSession session)`
  Returns all searches from this repository, including all of the user's searches and any shared searches.
  `IDfCollection`
  IDfSearchStoreService.`getCurrentUserSearches()`
  Deprecated.
  Use getCurrentUserSearches(IDfSession) instead
  `IDfCollection`
  IDfSearchStoreService.`getCurrentUserSearches(IDfSession session)`
  Returns only the user's searches from this repository.