Package com.documentum.fc.client

# Interface IDfObjectPath

public interface IDfObjectPath
Representation of user-accessible path to a given object.

Since:
  5.3

- ## Method Summary

  Modifier and Type
  Method
  Description
  `IDfList`
  `getAccessibleFolderIds()`
  Returns `IDfList` of accessible folder ids.
  `String`
  `getAccessiblePath()`
  Returns user-accessible path.
  `String`
  `getFullPath()`
  Returns object path.
  `boolean`
  `isPartial()`

- ## Method Details

  - ### getFullPath

    String getFullPath()
    Returns object path.
    Returns:
      object path as a String.

  - ### getAccessibleFolderIds

    IDfList getAccessibleFolderIds()
    Returns `IDfList` of accessible folder ids. This list has the longest sequence of folder ids in a given object path, that are accessible by user, from the bottom up. Sequence of ids in this list corresponds to a value, returned by getAccessiblePath(). For example, if path is “/a/b/c/x/y/z”, and c is not accessible, but x, y, and z are, the return value is a list that has ids of "x", "y", and "z".
    Returns:
      IDfList list of `IDfId` objects.

  - ### getAccessiblePath

    String getAccessiblePath()
    Returns user-accessible path. This `String` has the longest sequence of folder names in a given object path, that are accessible by user, from the bottom up. It starts with "/" only if path is fully accessible. For example, if path is “/a/b/c/x/y/z”, and c is not accessible, but x, y, and z are, the return value is "x/y/z".
    Returns:
      user-accessible path as a String.

  - ### isPartial

    boolean isPartial()
    Returns:
      true, if path is partial, false otherwise.