Interface DirectoryEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
All Known Subinterfaces:
Directory, File
public interface DirectoryEntry extends OsidObject

DirectoryEntry defines methods in common to both File and Directory . The concatenated path and name are assumed to be unique.

  • Method Details

    • getName

      String getName()
      Gets the name of this entry. The name does not include the path. If this entry represents an alias, the name of the alias is returned.
      Returns:
      the entry name
      Compliance:
      mandatory - This method must be implemented.

    • isAlias

      boolean isAlias()
      Tests if this entry is an alias.
      Returns:
      true if this is an alias, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPath

      String getPath()
      Gets the full path of this entry. The path includes the name. Path components are separated by a /. If this entry represents an alias, the path to the alias is returned.
      Returns:
      the path
      Compliance:
      mandatory - This method must be implemented.

    • getRealPath

      String getRealPath()
      Gets the real path of this entry. The path includes the name. Path components are separated by a /. If this entry represents an alias, the full path to the target file or directory is returned.
      Returns:
      the path
      Compliance:
      mandatory - This method must be implemented.

    • getOwnerId

      Id getOwnerId()
      Gets the Id of the Agent that owns this entry.
      Returns:
      the Agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getOwner

      Agent getOwner() throws OperationFailedException
      Gets the Agent that owns this entry.
      Returns:
      the Agent
      Throws:
      OperationFailedException - authentication service not available
      Compliance:
      mandatory - This method must be implemented.

    • getCreatedTime

      DateTime getCreatedTime()
      Gets the created time of this entry.
      Returns:
      the created time
      Compliance:
      mandatory - This method must be implemented.

    • getLastModifiedTime

      DateTime getLastModifiedTime()
      Gets the last modified time of this entry.
      Returns:
      the last modified time
      Compliance:
      mandatory - This method must be implemented.

    • getLastAccessTime

      DateTime getLastAccessTime()
      Gets the last access time of this entry.
      Returns:
      the last access time
      Compliance:
      mandatory - This method must be implemented.