Class AbstractOperableOsidObjectForm

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractIdentifiable

net.okapia.osid.jamocha.spi.AbstractOsidForm

net.okapia.osid.jamocha.spi.AbstractOsidExtensibleForm

net.okapia.osid.jamocha.spi.AbstractOsidBrowsableForm

net.okapia.osid.jamocha.spi.AbstractOsidObjectForm

net.okapia.osid.jamocha.spi.AbstractOperableOsidObjectForm

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractOsidRuleForm

public abstract class AbstractOperableOsidObjectForm
extends AbstractOsidObjectForm
implements OsidObjectForm, OsidOperableForm

A basic OsidOperableForm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractOperableOsidObjectForm.OsidOperableForm	Defines an OsidOperableForm.

Nested classes/interfaces inherited from class AbstractOsidExtensibleForm

AbstractOsidExtensibleForm.Extensible

Modifier and Type	Class	Description
protected class	AbstractOsidExtensibleForm.Extensible	Defines an Extensible.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOperableOsidObjectForm(Locale locale, boolean update)	Constructs a new AbstractOperableOsidObjectForm.

Method Summary

Modifier and Type	Method	Description
void	clearDisabled()	Clears the disabled flag.
void	clearEnabled()	Clears the enabled flag.
protected boolean	getDisabled()	Returns the current disabled value.
protected Id	getDisabledId()	Gets the Id for the disabled field.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled.
protected boolean	getEnabled()	Returns the current enabled value.
protected Id	getEnabledId()	Gets the Id for the enabled field.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled.
protected boolean	isDisabledCleared()	Tests if the disabled flag has been cleared in this form.
protected boolean	isDisabledSet()	Tests if the disabled flag has been set in this form.
protected boolean	isEnabledCleared()	Tests if the enabled flag has been cleared in this form.
protected boolean	isEnabledSet()	Tests if the enabled flag has been set in this form.
void	setDisabled(boolean disabled)	Sets the disabled flag.
protected void	setDisabledMetadata(Metadata metadata)	Sets the disabled metadata.
void	setEnabled(boolean enabled)	Sets the enabled flag.
protected void	setEnabledMetadata(Metadata metadata)	Sets the enabled metadata.

Methods inherited from class AbstractOsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescription, getDescriptionId, getDescriptionMetadata, getDisplayName, getDisplayNameId, getDisplayNameMetadata, getGenusType, getGenusTypeId, getGenusTypeMetadata, isDescriptionCleared, isDescriptionSet, isDisplayNameCleared, isDisplayNameSet, isGenusTypeCleared, isGenusTypeSet, setDescription, setDescriptionMetadata, setDisplayName, setDisplayNameMetadata, setGenusType, setGenusTypeMetadata

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
protected String	getDescription()	Returns the current description value.
protected Id	getDescriptionId()	Gets the Id for the description field.
Metadata	getDescriptionMetadata()	Gets the metadata for the description.
protected String	getDisplayName()	Returns the current display name value.
protected Id	getDisplayNameId()	Gets the Id for the display name field.
Metadata	getDisplayNameMetadata()	Gets the metadata for the display name.
protected Type	getGenusType()	Returns the current genus type value.
protected Id	getGenusTypeId()	Gets the Id for the genus type field.
Metadata	getGenusTypeMetadata()	Gets the metadata for the genus type.
protected boolean	isDescriptionCleared()	Tests if a description has been cleared in this form.
protected boolean	isDescriptionSet()	Tests if a description has been set in this form.
protected boolean	isDisplayNameCleared()	Tests if the display name has been cleared in this form.
protected boolean	isDisplayNameSet()	Tests if the display name has been set in this form.
protected boolean	isGenusTypeCleared()	Tests if a genus type has been cleared in this form.
protected boolean	isGenusTypeSet()	Tests if a genus type has been set in this form.
void	setDescription(String description)	Sets a description.
protected void	setDescriptionMetadata(Metadata metadata)	Sets the description metadata.
void	setDisplayName(String displayName)	Sets a display name.
protected void	setDisplayNameMetadata(Metadata metadata)	Sets the display name metadata.
void	setGenusType(Type genusType)	Sets a genus type.
protected void	setGenusTypeMetadata(Metadata metadata)	Sets the genus type metadata.

Methods inherited from class AbstractOsidExtensibleForm

addRecordType, addRequiredRecordType, getRecordTypes, getRequiredRecordTypes, hasRecordType

Modifier and Type	Method	Description
protected void	addRecordType(Type recordType)	Adds a record type.
protected void	addRequiredRecordType(Type requiredRecordType)	Adds a required record type.
TypeList	getRecordTypes()	Gets the record types available in this object.
TypeList	getRequiredRecordTypes()	Gets the required record types for this form.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from class AbstractOsidForm

addLocale, addLocales, clearLocales, getDefaultArrayIdMetadata, getDefaultArrayTypeMetadata, getDefaultBooleanMetadata, getDefaultDateTimeMetadata, getDefaultIdMetadata, getDefaultLocale, getDefaultStringMetadata, getDefaultTypeMetadata, getInvalidMetadata, getJournalComment, getJournalCommentId, getJournalCommentMetadata, getLocale, getLocales, getValidationMessages, isForUpdate, isJournalCommentSet, isValid, makeElementId, makeId, setJournalComment, setJournalCommentMetadata, setLocale

Modifier and Type	Method	Description
protected void	addLocale(Locale locale)	Adds an available locale.
protected void	addLocales(Collection<Locale> locales)	Adds a collection of available locales.
protected void	clearLocales()	Clears the available locales.
protected Metadata	getDefaultArrayIdMetadata(Id elementId, String field)	Gets a default read-only metadata for Ids.
protected Metadata	getDefaultArrayTypeMetadata(Id elementId, String field)	Gets a default read-only metadata for arrays of types.
protected Metadata	getDefaultBooleanMetadata(Id elementId, String field)	Gets a default read-only metadata for booleans.
protected Metadata	getDefaultDateTimeMetadata(Id elementId, String field)	Gets a default read-only metadata for date times.
protected Metadata	getDefaultIdMetadata(Id elementId, String field)	Gets a default read-only metadata for Ids.
Locale	getDefaultLocale()	Gets a default locale for DisplayTexts when a locale is not specified.
protected Metadata	getDefaultStringMetadata(Id elementId, String field)	Gets a default read-only metadata for strings.
protected Metadata	getDefaultTypeMetadata(Id elementId, String field)	Gets a default read-only metadata for types.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
protected String	getJournalComment()	Returns the current comment value.
protected Id	getJournalCommentId()	Gets the Id for the comment field.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
protected Locale	getLocale()	Gets the current locale.
LocaleList	getLocales()	Gets a list of locales for available DisplayText translations that can be performed using 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.
protected boolean	isJournalCommentSet()	Tests if a comment has been set in this form.
boolean	isValid()	Tests if ths form is in a valid state for submission.
protected Id	makeElementId(String identifier)	Makes an Id for a form element.
protected Id	makeId()	Generates a unique Id for this form.
void	setJournalComment(String comment)	Sets a comment.
protected void	setJournalCommentMetadata(Metadata metadata)	Sets the comment metadata.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for DisplayText fields in this form.

Methods inherited from class AbstractIdentifiable

current, equals, getId, hashCode, isCurrent, setId, stale, toString

Modifier and Type	Method	Description
protected void	current()	Sets the current flag to true.
final boolean	equals(Object obj)	Determines if the given Id is equal to this one.
Id	getId()	Gets the Id associated with this instance of this OSID object.
int	hashCode()	Returns a hash code value for this OsidObject based on the Id.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.
protected void	setId(Id id)	Sets the Id associated with this instance of this OSID object.
protected void	stale()	Sets the current flag to false.
String	toString()	Returns a string representation of this OsidObject.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractOperableOsidObjectForm

protected AbstractOperableOsidObjectForm(Locale locale,
 boolean update)

Constructs a new AbstractOperableOsidObjectForm.

Parameters:

locale - this serves as the default Locale for this form which generally is the Locale of the associated session. Additional locales may be set.

update - true if for update, false if for create

Method Details

getEnabledMetadata

@OSID
public Metadata getEnabledMetadata()

Gets the metadata for the enabled.

Specified by:

getEnabledMetadata in interface OsidOperableForm

Returns:

metadata for the enabled

setEnabledMetadata

protected void setEnabledMetadata(Metadata metadata)

Sets the enabled metadata.

Parameters:

metadata - the enabled metadata

Throws:

NullArgumentException - metadata is null

getEnabledId

protected Id getEnabledId()

Gets the Id for the enabled field.

Returns:

the enabled field Id

setEnabled

@OSID
public void setEnabled(boolean enabled)

Sets the enabled flag.

Specified by:

setEnabled in interface OsidOperableForm

Parameters:

enabled - the new enabled flag

Throws:

InvalidArgumentException - enabled is invalid

NoAccessException - Metadata.isReadonly() is true

clearEnabled

@OSID
public void clearEnabled()

Clears the enabled flag.

Specified by:

clearEnabled in interface OsidOperableForm

Throws:

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

isEnabledSet

protected boolean isEnabledSet()

Tests if the enabled flag has been set in this form.

Returns:

true if the enabled has been set, false otherwise

isEnabledCleared

protected boolean isEnabledCleared()

Tests if the enabled flag has been cleared in this form.

Returns:

true if the enabled has been cleared, false otherwise

getEnabled

protected boolean getEnabled()

Returns the current enabled value.

Returns:

the enabled value or null if isEnabledSet() is false

getDisabledMetadata

@OSID
public Metadata getDisabledMetadata()

Gets the metadata for the disabled.

Specified by:

getDisabledMetadata in interface OsidOperableForm

Returns:

metadata for the disabled

setDisabledMetadata

protected void setDisabledMetadata(Metadata metadata)

Sets the disabled metadata.

Parameters:

metadata - the disabled metadata

Throws:

NullArgumentException - metadata is null

getDisabledId

protected Id getDisabledId()

Gets the Id for the disabled field.

Returns:

the disabled field Id

setDisabled

@OSID
public void setDisabled(boolean disabled)

Sets the disabled flag.

Specified by:

setDisabled in interface OsidOperableForm

Parameters:

disabled - the new disabled flag

Throws:

InvalidArgumentException - disabled is invalid

NoAccessException - Metadata.isReadonly() is true

clearDisabled

@OSID
public void clearDisabled()

Clears the disabled flag.

Specified by:

clearDisabled in interface OsidOperableForm

Throws:

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

isDisabledSet

protected boolean isDisabledSet()

Tests if the disabled flag has been set in this form.

Returns:

true if the disabled has been set, false otherwise

isDisabledCleared

protected boolean isDisabledCleared()

Tests if the disabled flag has been cleared in this form.

Returns:

true if the disabled has been cleared, false otherwise

getDisabled

protected boolean getDisabled()

Returns the current disabled value.

Returns:

the disabled value or null if isDisabledSet() is false