Interface PostEntryForm

All Superinterfaces:

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

public interface PostEntryForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating PostEntries. Like all OsidForms, various data elements may be set here for use in the create and update methods in the PostEntryAdminSession. 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	clearAccount()	Removes the account.
void	clearActivity()	Removes the activity.
void	clearAmount()	Removes the amount.
void	clearDebit()	Clears the debit flag.
Metadata	getAccountMetadata()	Gets the metadata for the account.
Metadata	getActivityMetadata()	Gets the metadata for the activity.
Metadata	getAmountMetadata()	Gets the metadata for the amount.
Metadata	getDebitMetadata()	Gets the metadata for the debit flag.
PostEntryFormRecord	getPostEntryFormRecord(Type postEntryRecordType)	Gets the PostEntryFormRecord corresponding to the given post entry record Type.
void	setAccount(Id accountId)	Sets the account.
void	setActivity(Id activityId)	Sets the activity.
void	setAmount(Currency amount)	Sets the amount.
void	setDebit(boolean debit)	Sets the debit flag.

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.

Method Details

getAccountMetadata

Metadata getAccountMetadata()

Gets the metadata for the account.

Returns:

metadata for the account

Compliance:

mandatory - This method must be implemented.

setAccount

void setAccount(Id accountId)

Sets the account.

Parameters:

accountId - the new account

Throws:

InvalidArgumentException - accountId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearAccount

void clearAccount()

Removes the account.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getActivityMetadata

Metadata getActivityMetadata()

Gets the metadata for the activity.

Returns:

metadata for the activity

Compliance:

mandatory - This method must be implemented.

setActivity

void setActivity(Id activityId)

Sets the activity.

Parameters:

activityId - the new activity

Throws:

InvalidArgumentException - activityId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivity

void clearActivity()

Removes the activity.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAmountMetadata

Metadata getAmountMetadata()

Gets the metadata for the amount.

Returns:

metadata for the amount

Compliance:

mandatory - This method must be implemented.

setAmount

void setAmount(Currency amount)

Sets the amount.

Parameters:

amount - the new amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - amount is null

Compliance:

mandatory - This method must be implemented.

clearAmount

void clearAmount()

Removes the amount.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDebitMetadata

Metadata getDebitMetadata()

Gets the metadata for the debit flag.

Returns:

metadata for the debit flag

Compliance:

mandatory - This method must be implemented.

setDebit

void setDebit(boolean debit)

Sets the debit flag.

Parameters:

debit - true if this post entry is a debit, false if a credit

Throws:

InvalidArgumentException - debit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearDebit

void clearDebit()

Clears the debit flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPostEntryFormRecord

PostEntryFormRecord getPostEntryFormRecord(Type postEntryRecordType)
                                    throws OperationFailedException

Gets the PostEntryFormRecord corresponding to the given post entry record Type.

Parameters:

postEntryRecordType - a post entry record type

Returns:

the post entry form record

Throws:

NullArgumentException - postEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.