org.osid.resource.batch

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

Methods

Modifier and Type	Method and 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 org.osid.resource.ResourceForm

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

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

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.