OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceBatchForm
Implementsosid.resource.ResourceForm
Description

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.

MethodgetResourceId
Description

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

Returnosid.id.Idthe resource Id
ErrorsILLEGAL_STATE isForUpdate() is false
CompliancemandatoryThis method must be implemented.
MethodgetAgentsMetadata
Description

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

Returnosid.Metadatametadata for the agents
CompliancemandatoryThis method must be implemented.
MethodsetAgents
Description

Sets the mapped agents.

Parametersosid.id.IdListagentsIdsa list of agent Ids
ErrorsINVALID_ARGUMENT agentIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAgents
Description

Clears the agents for this resource.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.