org.osid.resourcing

Interface AvailabilityForm

All Superinterfaces:

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

All Known Subinterfaces:

AvailabilityBatchForm

public interface AvailabilityForm
extends OsidRelationshipForm

This is the form for creating and updating Availabilities. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AvailabilityAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCompetency() Removes the competency.
void	clearPercentage() Removes the percentage availability.
AvailabilityFormRecord	getAvailabilityFormRecord(Type availabilityRecordType) Gets the AvailabilityFormRecord corresponding to the given availability record Type.
Metadata	getCompetencyMetadata() Gets the metadata for the competency.
Metadata	getPercentageMetadata() Gets the metadata for the percentage availability.
void	setCompetency(Id competencyId) Sets the competency.
void	setPercentage(long availability) Sets the percent availability.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCompetencyMetadata

Metadata getCompetencyMetadata()

Gets the metadata for the competency.

Returns:

metadata for the competency

Compliance:

mandatory - This method must be implemented.

setCompetency

void setCompetency(Id competencyId)

Sets the competency.

Parameters:

competencyId - the new competency

Throws:

InvalidArgumentException - competencyId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - competencyId is null

Compliance:

mandatory - This method must be implemented.

clearCompetency

void clearCompetency()

Removes the competency.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPercentageMetadata

Metadata getPercentageMetadata()

Gets the metadata for the percentage availability.

Returns:

metadata for the percentage availability

Compliance:

mandatory - This method must be implemented.

setPercentage

void setPercentage(long availability)

Sets the percent availability.

Parameters:

availability - the new percentage vaailability

Throws:

InvalidArgumentException - availability is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearPercentage

void clearPercentage()

Removes the percentage availability.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAvailabilityFormRecord

AvailabilityFormRecord getAvailabilityFormRecord(Type availabilityRecordType)
                                                 throws OperationFailedException

Gets the AvailabilityFormRecord corresponding to the given availability record Type.

Parameters:

availabilityRecordType - an availability record type

Returns:

the availability form record

Throws:

NullArgumentException - availabilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilityRecordType) is false

Compliance:

mandatory - This method must be implemented.