Interface AuthorizationBatchManager

All Superinterfaces:

AuthorizationBatchProfile, AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 AuthorizationBatchProfile

supportsAuthorizationBatchAdmin, supportsFunctionBatchAdmin, supportsQualifierBatchAdmin, supportsVaultBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAuthorizationBatchAdmin()	Tests if bulk administration of authorizations is available.
boolean	supportsFunctionBatchAdmin()	Tests if bulk administration of functions is available.
boolean	supportsQualifierBatchAdmin()	Tests if bulk administration of qualifiers is available.
boolean	supportsVaultBatchAdmin()	Tests if bulk administration of vaults is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsAuthorizationBatchAdmin()} is {@code 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 {@code supportsAuthorizationBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsFunctionBatchAdmin()} is {@code 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 {@code supportsFunctionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsQualifierBatchAdmin()} is {@code 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 {@code supportsQualifierBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsVaultBatchAdmin()} is {@code true} .