org.osid.financials

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 OsidForm objects, 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

Methods

Modifier and Type	Method and 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(java.lang.String code) Sets the code.
void	setOrganization(Id organizationId) Sets the organization.
void	setSupervisor(Id supervisorId) Sets the supervisor.

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

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(java.lang.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.