OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.File
Implementsosid.filing.DirectoryEntry
Description

File represents a file in a file system.

MethodhasSize
Description

Tests if this file has a known size.

Returnboolean true if this file has a size, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSize
Description

Gets the size of this file in bytes if hasSize() is true.

Returncardinalthe size of this file
ErrorsILLEGAL_STATE hasSize() is false
CompliancemandatoryThis method must be implemented.
MethodgetFileRecord
Description

Gets the file record corresponding to the given File record Type. This method is used to retrieve an object implementing the requested record. The fileRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(fileRecordType) is true .

Parametersosid.type.TypefileRecordTypethe file record type
Returnosid.filing.records.FileRecordthe file record
ErrorsNULL_ARGUMENT fileRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fileRecordType) is false
CompliancemandatoryThis method must be implemented.