org.osid.filing

Interface DirectoryEntryForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

DirectoryForm, FileForm

public interface DirectoryEntryForm
extends OsidObjectForm

DirectoryEntryForm defines methods in common to both FileForm and DirectoryForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearOwner() Clears the owner.
Metadata	getOwnerMetadata() Gets the metadata for the owner.
void	setOwner(Id agentId) Sets the owner.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getOwnerMetadata

Metadata getOwnerMetadata()

Gets the metadata for the owner.

Returns:

metadata for the owner

Compliance:

mandatory - This method must be implemented.

setOwner

void setOwner(Id agentId)

Sets the owner.

Parameters:

agentId - the new owner

Throws:

InvalidArgumentException - agentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearOwner

void clearOwner()

Clears the owner.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.