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.
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.
|
clearAvatar, clearGroup, getAvatarMetadata, getGroupMetadata, getResourceFormRecord, setAvatar, setGroup
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Id getResourceId()
Id
of the resource to be updated if this is an
update transaction. Id
IllegalStateException
- isForUpdate()
is
false
mandatory
- This method must be implemented. Metadata getAgentsMetadata()
mandatory
- This method must be implemented. void setAgents(IdList agentsIds)
agentsIds
- a list of agent Ids
InvalidArgumentException
- agentIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAgents()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented.