org.osid.authorization

Interface Vault

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Vault
extends OsidCatalog

A vault defines a collection of authorizations and functions.

Method Summary

Methods

Modifier and Type	Method and Description
VaultRecord	getVaultRecord(Type vaultRecordType) Gets the vault record corresponding to the given Vault record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getVaultRecord

VaultRecord getVaultRecord(Type vaultRecordType)
                           throws OperationFailedException

Gets the vault record corresponding to the given Vault record Type. This method is used to retrieve an object implementing the requested record. The vaultRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(vaultRecordType) is true .

Parameters:

vaultRecordType - a vault record type

Returns:

the vault record

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultRecordType) is false

Compliance:

mandatory - This method must be implemented.