OSID Logo
OSID Specifications
profile batch package
Version 3.1.0
Interfaceosid.profile.batch.ProfileEntryBatchForm
Implementsosid.profile.ProfileEntryForm
Used Byosid.profile.batch.ProfileEntryBatchFormList
Description

This is the form for creating and updating profile entries in bulk. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ProfileEntryBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodhasAgent
Description

Tests if the create request specified an agent.

Returnboolean true if an agent is available, false otherwise
ErrorsILLEGAL_STATE isForUpdate() is true
Compliancemandatory This method must be implemented.
MethodgetAgentId
Description

Gets the Agent Id of the profile entry if this is a create transaction using an agent.

Returnosid.id.Id the resource Id
ErrorsILLEGAL_STATE isForUpdate() is true or hasAgent() is false
Compliancemandatory This method must be implemented.
MethodhasResource
Description

Tests if the create request specified a resource.

Returnboolean true if a resource is available, false otherwise
ErrorsILLEGAL_STATE isForUpdate() is true
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the Resource Id of the profile entry if this is a create transaction using a resource.

Returnosid.id.Id the resource Id
ErrorsILLEGAL_STATE isForUpdate() is true or hasResource() is false
Compliancemandatory This method must be implemented.
MethodgetProfileItemId
Description

Gets the work Id of the profile item if this is a create transaction.

Returnosid.id.Id the profile item Id
ErrorsILLEGAL_STATE isForUpdate() is true
Compliancemandatory This method must be implemented.
MethodgetProfileEntryId
Description

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

Returnosid.id.Id the profile entry Id
ErrorsILLEGAL_STATE isForUpdate() is false
Compliancemandatory This method must be implemented.