org.osid.filing

Interface Directory

All Superinterfaces:

Browsable, DirectoryEntry, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Directory
extends OsidCatalog, DirectoryEntry

Directory represents a directory in a file system that may contain other files and directories.

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryRecord	getDirectoryRecord(Type directoryRecordType) Gets the directory record corresponding to the given Directory record Type.

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Methods inherited from interface org.osid.filing.DirectoryEntry

getCreatedTime, getLastAccessTime, getLastModifiedTime, getName, getOwner, getOwnerId, getPath, getRealPath, isAlias

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getDirectoryRecord

DirectoryRecord getDirectoryRecord(Type directoryRecordType)
                                   throws OperationFailedException

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

Parameters:

directoryRecordType - the directory record type

Returns:

the directory record

Throws:

NullArgumentException - directoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directoryRecordType) is false

Compliance:

mandatory - This method must be implemented.