org.osid.authorization.batch

Interface AuthorizationBatchManager

All Superinterfaces:

AuthorizationBatchProfile, java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface AuthorizationBatchManager
extends OsidManager, AuthorizationBatchProfile

The authorization batch manager provides access to authorization batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• AuthorizationBatchAdminSession: a session to create, modify and delete authorizations in bulk
• FunctionBatchSession: a session to create, modify and delete functions in bulk
• QualifierBatchAdminSession: a session to create, modify and delete qualifiers in bulk
• VaultBatchAdminSession: a session to create, modify and delete vaults in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationBatchAdminSession	getAuthorizationBatchAdminSession() Gets the OsidSession associated with the bulk authorization administration service.
AuthorizationBatchAdminSession	getAuthorizationBatchAdminSessionForVault(Id vaultId) Gets the OsidSession associated with the bulk authorization administration service for the given vault.
FunctionBatchAdminSession	getFunctionBatchAdminSession() Gets the OsidSession associated with the bulk function administration service.
FunctionBatchAdminSession	getFunctionBatchAdminSessionForVault(Id vaultId) Gets the OsidSession associated with the bulk function administration service for the given vault.
QualifierBatchAdminSession	getQualifierBatchAdminSession() Gets the OsidSession associated with the bulk qualifier administration service.
QualifierBatchAdminSession	getQualifierBatchAdminSessionForVault(Id vaultId) Gets the OsidSession associated with the bulk qualifier administration service for the given vault.
VaultBatchAdminSession	getVaultBatchAdminSession() Gets the OsidSession associated with the bulk vault administration service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.authorization.batch.AuthorizationBatchProfile

supportsAuthorizationBatchAdmin, supportsFunctionBatchAdmin, supportsQualifierBatchAdmin, supportsVaultBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAuthorizationBatchAdminSession

AuthorizationBatchAdminSession getAuthorizationBatchAdminSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk authorization administration service.

Returns:

an AuthorizationBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationBatchAdmin() is true.

getAuthorizationBatchAdminSessionForVault

AuthorizationBatchAdminSession getAuthorizationBatchAdminSessionForVault(Id vaultId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the bulk authorization administration service for the given vault.

Parameters:

vaultId - the Id of the Vault

Returns:

an AuthorizationBatchAdminSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationBatchAdmin() and supportsVisibleFederation() are true

getFunctionBatchAdminSession

FunctionBatchAdminSession getFunctionBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk function administration service.

Returns:

a FunctionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsFunctionBatchAdmin() is true.

getFunctionBatchAdminSessionForVault

FunctionBatchAdminSession getFunctionBatchAdminSessionForVault(Id vaultId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the bulk function administration service for the given vault.

Parameters:

vaultId - the Id of the Vault

Returns:

a FunctionBatchAdminSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFunctionBatchAdmin() and supportsVisibleFederation() are true

getQualifierBatchAdminSession

QualifierBatchAdminSession getQualifierBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk qualifier administration service.

Returns:

a QualifierBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsQualifierBatchAdmin() is true.

getQualifierBatchAdminSessionForVault

QualifierBatchAdminSession getQualifierBatchAdminSessionForVault(Id vaultId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the bulk qualifier administration service for the given vault.

Parameters:

vaultId - the Id of the Vault

Returns:

a QualifierBatchAdminSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQualifierBatchAdmin() and supportsVisibleFederation() are true

getVaultBatchAdminSession

VaultBatchAdminSession getVaultBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk vault administration service.

Returns:

a VaultBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsVaultBatchAdmin() is true.