Docs For Class CabinetEntry

Class CabinetEntry

Description

An entry in a Cabinet, a CabinetEntry is either a ByteStore or a Cabinet.

CabinetEntry contains information common to both Cabinets and Bytestores

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/filing/CabinetEntry.php (line 18)

Direct descendents

Class	Description
Cabinet	Cabinets contain other Cabinets and ByteStores, and have implementation-dependent properties.

Method Summary

boolean exists ()

object LongValueIterator getAllModifiedTimes ()

object Id getCabinetEntryAgentId ()

int getCreatedTime ()

string getDisplayName ()

object Id getId ()

int getLastAccessedTime ()

int getLastModifiedTime ()

object Cabinet getParent ()

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

void touch ()

void updateDisplayName (mixed $displayName, string $displayName )

Methods

exists (line 57)

Returns true or false depending on whether this CabinetEntry exists in the file system.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR

boolean exists ()

getAllModifiedTimes (line 185)

Returns all the times that this Cabinet was modified.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: IO_ERROR, UNIMPLEMENTED

object LongValueIterator getAllModifiedTimes ()

getCabinetEntryAgentId (line 260)

Return the Id of the Agent that owns this CabinetEntry.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR, UNIMPLEMENTED

object Id getCabinetEntryAgentId ()

getCreatedTime (line 241)

Returns when this CabinetEntry was created. Not all implementations will record the time of creation accurately. The value returned will be at least the last modified time, the actual creation time may be earlier.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: IO_ERROR, UNIMPLEMENTED

int getCreatedTime ()

getDisplayName (line 138)

Return the name of this CabinetEntry in its parent Cabinet.

access: public
throws: object FilingException

string getDisplayName ()

getId (line 151)

Get Id of this CabinetEntry

access: public
throws: object FilingException

object Id getId ()

getLastAccessedTime (line 222)

Returns when this Cabinet was last accessed. Not all implementations will record last access times accurately, due to caching and performance. The value returned will be at least the last modified time, the actual time when a read was performed may be later.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: IO_ERROR, UNIMPLEMENTED

int getLastAccessedTime ()

getLastModifiedTime (line 168)

Returns when this Cabinet was last modified.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: IO_ERROR, UNIMPLEMENTED

int getLastModifiedTime ()

getParent (line 76)

Returns the Cabinet in which this CabinetEntry is an entry, or null if it has no parent (for example is the root Cabinet).

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR

object Cabinet getParent ()

getProperties (line 125)

Get the Properties associated with this CabinetEntry.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PropertiesIterator getProperties ()

getPropertiesByType (line 103)

Get the Properties of this Type associated with this CabinetEntry.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

getPropertyTypes (line 38)

Get all the Property Types for CabinetEntry.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getPropertyTypes ()

touch (line 202)

Sets the last-modified time to the current time for this CabinetEntry.

access: public
throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR, UNIMPLEMENTED

void touch ()

updateDisplayName (line 273)

Change the name of this CabinetEntry to

displayName

access: public
throws: object FilingException

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Documentation generated on Wed, 19 Sep 2007 10:21:57 -0400 by phpDocumentor 1.3.0RC3