Interface Allocation

All Superinterfaces:
Browsable, Extensible
public interface Allocation extends Extensible, Browsable

Allocation represents allocated resources in a file system.

  • Method Details

    • getDirectoryPath

      String getDirectoryPath()
      Gets the absolute path to the directory responsible for these usage stats. The return may be a partition or volume containing the requested directory.
      Returns:
      path name
      Compliance:
      mandatory - This method must be implemented.

    • getDirectory

      Directory getDirectory()
      Gets the directory responsible for these usage stats. The return may be a partition, quota controlled directory, or volume containing the requested directory.
      Returns:
      directory
      Compliance:
      mandatory - This method must be implemented.

    • isAssignedToUser

      boolean isAssignedToUser()
      Tests if this allocation is assigned to a specific user.
      Returns:
      true if this allocation is assigned to a specific user, false if this allocation applied to all users
      Compliance:
      mandatory - This method must be implemented.

    • getAgentId

      Id getAgentId()
      Gets the agent Id of the user.
      Returns:
      the agent Id
      Throws:
      IllegalStateException - isAssignedToUser() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAgent

      Agent getAgent() throws OperationFailedException
      Gets the agent of the user.
      Returns:
      the agent
      Throws:
      IllegalStateException - isAssignedToUser() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTotalSpace

      long getTotalSpace()
      Gets the total space in bytes of this allocation.
      Returns:
      number of bytes in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getUsedSpace

      long getUsedSpace()
      Gets the used space in bytes of this allocation.
      Returns:
      number of used bytes in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getAvailableSpace

      long getAvailableSpace()
      Gets the available space in bytes of this allocation.
      Returns:
      number of available bytes in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getTotalFiles

      long getTotalFiles()
      Gets the total number of files of this allocation.
      Returns:
      number of files in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getUsedFiles

      long getUsedFiles()
      Gets the used number of files of this allocation.
      Returns:
      number of used files in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getAvailableFiles

      long getAvailableFiles()
      Gets the available number o files of this allocation.
      Returns:
      number of available files in this allocation
      Compliance:
      mandatory - This method must be implemented.

    • getAllocationRecord

      AllocationRecord getAllocationRecord(Type allocationRecordType) throws OperationFailedException
      Gets the allocation record corresponding to the given Allocation record Type. This method is used to retrieve an object implementing the requested record. The allocationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(allocationRecordType) is true.
      Parameters:
      allocationRecordType - the allocation record type
      Returns:
      the allocation record
      Throws:
      NullArgumentException - allocationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(allocationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.