OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.HoldBatchForm
Implementsosid.hold.HoldForm
Description

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

MethodgetIssueId
Description

Gets the issue Id of the issue if this is a create transaction.

Returnosid.id.Idthe issue Id
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodhasAgent
Description

Tests if this create form was requested using an agent.

Returnboolean true if the create request specified an agent, false otherwise
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodgetAgentId
Description

Gets the agent Id of the issue if this is a create transaction.

Returnosid.id.Idthe agent Id
ErrorsILLEGAL_STATE isForUpdate() is true or hasAgent() is false
CompliancemandatoryThis method must be implemented.
MethodhasResource
Description

Tests if this create form was requested using a resource.

Returnboolean true if the create request specified a resource, false otherwise
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the resource Id of the issue if this is a create transaction.

Returnosid.id.Idthe resource Id
ErrorsILLEGAL_STATE isForUpdate() is true or hasResource() is false
CompliancemandatoryThis method must be implemented.
MethodgetHoldId
Description

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

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