Interface ResourceBatchForm

All Superinterfaces:

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

public interface ResourceBatchForm
extends ResourceForm

This is the form for creating and updating resources in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ResourceBatchAdminSession . 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	clearAgents()	Clears the agents for this resource.
Metadata	getAgentsMetadata()	Gets the metadata for a list of agents for this resource.
Id	getResourceId()	Gets the Id of the resource to be updated if this is an update transaction.
void	setAgents(IdList agentsIds)	Sets the mapped agents.

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.

Methods inherited from interface ResourceForm

clearAvatar, clearGroup, getAvatarMetadata, getGroupMetadata, getResourceFormRecord, setAvatar, setGroup

Modifier and Type	Method	Description
void	clearAvatar()	Clears the asset.
void	clearGroup()	Clears the group designation.
Metadata	getAvatarMetadata()	Gets the metadata for an asset.
Metadata	getGroupMetadata()	Gets the metadata for a group.
ResourceFormRecord	getResourceFormRecord(Type resourceRecordType)	Gets the ResourceFormRecord corresponding to the given Resource record Type .
void	setAvatar(Id assetId)	Sets the avatar asset.
void	setGroup(boolean group)	Sets the resource as a group.

Method Details

getResourceId

Id getResourceId()

Gets the Id of the resource to be updated if this is an update transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.

getAgentsMetadata

Metadata getAgentsMetadata()

Gets the metadata for a list of agents for this resource.

Returns:

metadata for the agents

Compliance:

mandatory - This method must be implemented.

setAgents

void setAgents(IdList agentsIds)

Sets the mapped agents.

Parameters:

agentsIds - a list of agent Ids

Throws:

InvalidArgumentException - agentIds is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAgents

void clearAgents()

Clears the agents for this resource.

Throws:

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

Compliance:

mandatory - This method must be implemented.