Interface AccountForm

All Superinterfaces:

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

All Known Subinterfaces:

AccountBatchForm

public interface AccountForm
extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Accounts. Like all OsidForms, various data elements may be set here for use in the create and update methods in the AccountAdminSession. 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	clearCreditBalance()	Removes the credit balance flag.
AccountFormRecord	getAccountFormRecord(Type accountRecordType)	Gets the AccountFormRecord corresponding to the given account record Type.
Metadata	getCodeMetadata()	Gets the metadata for the code.
Metadata	getCreditBalanceMetadata()	Gets the metadata for the credit balance.
void	setCode(String code)	Sets the code.
void	setCreditBalance(boolean credit)	Sets the credit balance 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

getCreditBalanceMetadata

Metadata getCreditBalanceMetadata()

Gets the metadata for the credit balance.

Returns:

metadata for the credit balance

Compliance:

mandatory - This method must be implemented.

setCreditBalance

void setCreditBalance(boolean credit)

Sets the credit balance flag.

Parameters:

credit - true if credits increase the balance, false if credits decrease the balance

Throws:

InvalidArgumentException - credit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreditBalance

void clearCreditBalance()

Removes the credit balance flag.

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.

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

NullArgumentException - code is null

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.

getAccountFormRecord

AccountFormRecord getAccountFormRecord(Type accountRecordType)
                                throws OperationFailedException

Gets the AccountFormRecord corresponding to the given account record Type.

Parameters:

accountRecordType - an account record type

Returns:

the account form record

Throws:

NullArgumentException - accountRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountRecordType) is false

Compliance:

mandatory - This method must be implemented.