Interface ActivityForm

All Superinterfaces:

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

All Known Subinterfaces:

ActivityBatchForm

public interface ActivityForm
extends OsidObjectForm, OsidFederateableForm, OsidTemporalForm

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

Method Summary

Modifier and Type	Method	Description
void	clearCode()	Removes the code.
void	clearOrganization()	Removes the organization.
void	clearSupervisor()	Removes the supervisor.
ActivityFormRecord	getActivityFormRecord(Type activityRecordType)	Gets the ActivityFormRecord corresponding to the given activity record Type.
Metadata	getCodeMetadata()	Gets the metadata for the code flag.
Metadata	getOrganizationMetadata()	Gets the metadata for the organization.
Metadata	getSupervisorMetadata()	Gets the metadata for the supervisor.
void	setCode(String code)	Sets the code.
void	setOrganization(Id organizationId)	Sets the organization.
void	setSupervisor(Id supervisorId)	Sets the supervisor.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getOrganizationMetadata

Metadata getOrganizationMetadata()

Gets the metadata for the organization.

Returns:

metadata for the organization

Compliance:

mandatory - This method must be implemented.

setOrganization

void setOrganization(Id organizationId)

Sets the organization.

Parameters:

organizationId - the new organization

Throws:

InvalidArgumentException - organizationId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - organizationId is null

Compliance:

mandatory - This method must be implemented.

clearOrganization

void clearOrganization()

Removes the organization.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSupervisorMetadata

Metadata getSupervisorMetadata()

Gets the metadata for the supervisor.

Returns:

metadata for the supervisor

Compliance:

mandatory - This method must be implemented.

setSupervisor

void setSupervisor(Id supervisorId)

Sets the supervisor.

Parameters:

supervisorId - the new supervisor

Throws:

InvalidArgumentException - supervisorId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - supervisorId is null

Compliance:

mandatory - This method must be implemented.

clearSupervisor

void clearSupervisor()

Removes the supervisor.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCodeMetadata

Metadata getCodeMetadata()

Gets the metadata for the code flag.

Returns:

metadata for the code

Compliance:

mandatory - This method must be implemented.

setCode

void setCode(String code)

Sets the code.

Parameters:

code - the new code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCode

void clearCode()

Removes the code.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getActivityFormRecord

ActivityFormRecord getActivityFormRecord(Type activityRecordType)
                                  throws OperationFailedException

Gets the ActivityFormRecord corresponding to the given activity record Type.

Parameters:

activityRecordType - an activity record type

Returns:

the activity form record

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRecordType) is false

Compliance:

mandatory - This method must be implemented.