OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.AuthorizationBatchForm
Implementsosid.authorization.AuthorizationForm
Description

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

MethodhasAgent
Description

Tests if this batch form was requested by specifying an agent if this is a create transaction.

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

Gets the Agent Id of the authorization 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 batch form was requested by specifying a resource if this is a create transaction.

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

Gets the Resource Id of the authorization 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.
MethodhasTrust
Description

Tests if this batch form was requested by specifying a trust if this is a create transaction.

Returnboolean true if a trust exists, false otherwise
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodgetTrustId
Description

Gets the Trust Id of the authorization if this is a create transaction.

Returnosid.id.Idthe trust Id
ErrorsILLEGAL_STATE isForUpdate() is true or hasTrust() is false
CompliancemandatoryThis method must be implemented.
MethodgetQualifierId
Description

Gets the qualifier Id of the authorization if this is a create transaction.

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

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

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