public interface ActivityForm extends OsidRelationshipForm, OsidSubjugateableForm
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.
Modifier and Type | Method and Description |
---|---|
void |
clearContact()
Removes the contact flag.
|
void |
clearInstructors()
Removes the instructors.
|
void |
clearMaximumSeats()
Removes the maximum seats.
|
void |
clearMinimumSeats()
Removes the minimum seats.
|
void |
clearRecurringWeekly()
Removes the recurring weekly flag.
|
void |
clearTotalTargetContactTime()
Removes the total contact time.
|
void |
clearTotalTargetEffort()
Removes the total effort.
|
void |
clearTotalTargetIndividualEffort()
Removes the total individual effort.
|
void |
clearWeeklyContactTime()
Removes the weekly contact time.
|
void |
clearWeeklyEffort()
Removes the weekly effort.
|
void |
clearWeeklyIndividualEffort()
Removes the weekly individual effort.
|
ActivityFormRecord |
getActivityFormRecord(Type activityRecordType)
Gets the
ActivityFormRecord corresponding to the given
activity record Type. |
Metadata |
getContactMetadata()
Gets the metadata for the contact flag.
|
Metadata |
getInstructorsMetadata()
Gets the metadata for the instructors.
|
Metadata |
getMaximumSeatsMetadata()
Gets the metadata for the maximum seats.
|
Metadata |
getMinimumSeatsMetadata()
Gets the metadata for the minimum seats.
|
Metadata |
getRecurringWeeklyMetadata()
Gets the metadata for the recurring weekly flag.
|
Metadata |
getTotalEffortMatadata()
Gets the metadata for the total effort.
|
Metadata |
getTotalTargetContactTimeMetadata()
Gets the metadata for the total contact time.
|
Metadata |
getTotalTargetIndividualEffortMetadata()
Gets the metadata for the total individual effort.
|
Metadata |
getWeeklyContactTimeMetadata()
Gets the metadata for the weekly contact time.
|
Metadata |
getWeeklyEffortMetadata()
Gets the metadata for the weekly effort.
|
Metadata |
getWeeklyIndividualEffortMetadata()
Gets the metadata for the weekly individual effort.
|
void |
setContact(boolean contact)
Sets the contact flag.
|
void |
setInstructors(Id[] resourceIds)
Sets the instructors.
|
void |
setMaximumSeats(long seats)
Sets the maximum seating count.
|
void |
setMinimumSeats(long seats)
Sets the minimum seating count.
|
void |
setRecurringWeekly(boolean recurring)
Sets the recurring weekly flag.
|
void |
setTotalTargetContactTime(Duration time)
Sets the total contact time.
|
void |
setTotalTargetEffort(Duration time)
Sets the total effort.
|
void |
setTotalTargetIndividualEffort(Duration time)
Sets the total individual effort.
|
void |
setWeeklyContactTime(Duration time)
Sets the weekly contact time.
|
void |
setWeeklyEffort(Duration time)
Sets the weekly effort.
|
void |
setWeeklyIndividualEffort(Duration time)
Sets the weekly individual effort.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getInstructorsMetadata()
mandatory
- This method must be implemented. void setInstructors(Id[] resourceIds)
resourceIds
- the new instructorsInvalidArgumentException
- instructorIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- instructorIds
is
null
mandatory
- This method must be implemented. void clearInstructors()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumSeatsMetadata()
mandatory
- This method must be implemented. void setMinimumSeats(long seats)
seats
- the new minimum seatsInvalidArgumentException
- seats
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumSeats()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMaximumSeatsMetadata()
mandatory
- This method must be implemented. void setMaximumSeats(long seats)
seats
- the new maximum seatsInvalidArgumentException
- seats
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMaximumSeats()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTotalEffortMatadata()
mandatory
- This method must be implemented. void setTotalTargetEffort(Duration time)
time
- the new total effortInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearTotalTargetEffort()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getContactMetadata()
mandatory
- This method must be implemented. void setContact(boolean contact)
contact
- the new contact flagInvalidArgumentException
- contact
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearContact()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTotalTargetContactTimeMetadata()
mandatory
- This method must be implemented. void setTotalTargetContactTime(Duration time)
time
- the new total contact timeInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearTotalTargetContactTime()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTotalTargetIndividualEffortMetadata()
mandatory
- This method must be implemented. void setTotalTargetIndividualEffort(Duration time)
time
- the new total individual effortInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearTotalTargetIndividualEffort()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRecurringWeeklyMetadata()
mandatory
- This method must be implemented. void setRecurringWeekly(boolean recurring)
recurring
- the new recurring weekly flagInvalidArgumentException
- recurring
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRecurringWeekly()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getWeeklyEffortMetadata()
mandatory
- This method must be implemented. void setWeeklyEffort(Duration time)
time
- the new weekly effortInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearWeeklyEffort()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getWeeklyContactTimeMetadata()
mandatory
- This method must be implemented. void setWeeklyContactTime(Duration time)
time
- the new weekly contact timeInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearWeeklyContactTime()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getWeeklyIndividualEffortMetadata()
mandatory
- This method must be implemented. void setWeeklyIndividualEffort(Duration time)
time
- the new weekly individual effortInvalidArgumentException
- time
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearWeeklyIndividualEffort()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ActivityFormRecord getActivityFormRecord(Type activityRecordType) throws OperationFailedException
ActivityFormRecord
corresponding to the given
activity record Type.
activityRecordType
- an activity record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.