org.osid.authorization.batch

Interface AuthorizationBatchForm

All Superinterfaces:

AuthorizationForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

public interface AuthorizationBatchForm
extends AuthorizationForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getAgentId() Gets the Agent Id of the authorization if this is a create transaction.
Id	getAuthorizationId() Gets the Id of the authorization to be updated if this is an update transaction.
Id	getQualifierId() Gets the qualifier Id of the authorization if this is a create transaction.
Id	getResourceId() Gets the Resource Id of the authorization if this is a create transaction.
Id	getTrustId() Gets the Trust Id of the authorization if this is a create transaction.
boolean	hasAgent() Tests if this batch form was requested by specifying an agent if this is a create transaction.
boolean	hasResource() Tests if this batch form was requested by specifying a resource if this is a create transaction.
boolean	hasTrust() Tests if this batch form was requested by specifying a trust if this is a create transaction.

Methods inherited from interface org.osid.authorization.AuthorizationForm

getAuthorizationFormRecord

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

hasAgent

boolean hasAgent()

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

Returns:

true if an agent exists, false otherwise

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getAgentId

Id getAgentId()

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

Returns:

the agent Id

Throws:

IllegalStateException - isForUpdate() is true or hasAgent() is false

Compliance:

mandatory - This method must be implemented.

hasResource

boolean hasResource()

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

Returns:

true if a resource exists, false otherwise

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true or hasResource() is false

Compliance:

mandatory - This method must be implemented.

hasTrust

boolean hasTrust()

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

Returns:

true if a trust exists, false otherwise

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTrustId

Id getTrustId()

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

Returns:

the trust Id

Throws:

IllegalStateException - isForUpdate() is true or hasTrust() is false

Compliance:

mandatory - This method must be implemented.

getQualifierId

Id getQualifierId()

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

Returns:

the qualifier Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getAuthorizationId

Id getAuthorizationId()

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

Returns:

the authorization Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.