org.osid.repository

Interface RepositoryProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

RepositoryManager, RepositoryProxyManager

public interface RepositoryProfile
extends OsidProfile

The repository profile describes interoperability among repository services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAssetContentRecordTypes() Gets all the asset content record types supported.
TypeList	getAssetRecordTypes() Gets all the asset record types supported.
TypeList	getAssetSearchRecordTypes() Gets all the asset search record types supported.
TypeList	getCompositionRecordTypes() Gets all the composition record types supported.
TypeList	getCompositionSearchRecordTypes() Gets all the composition search record types supported.
TypeList	getCoordinateTypes() Gets all the coordinate types supported.
TypeList	getRepositoryRecordTypes() Gets all the repository record types supported.
TypeList	getRepositorySearchRecordTypes() Gets all the repository search record types supported.
TypeList	getSpatialUnitRecordTypes() Gets all the spatial unit record types supported.
boolean	supportsAssetAdmin() Tests if asset administration is supported.
boolean	supportsAssetComposition() Tests if assets are included in compositions.
boolean	supportsAssetCompositionDesign() Tests if mapping assets to compositions is supported.
boolean	supportsAssetContentRecordType(Type assetContentRecordType) Tests if a given asset content record type is supported.
boolean	supportsAssetLookup() Tests if asset lookup is supported.
boolean	supportsAssetNotification() Tests if asset notification is supported.
boolean	supportsAssetQuery() Tests if asset query is supported.
boolean	supportsAssetRecordType(Type assetRecordType) Tests if a given asset type is supported.
boolean	supportsAssetRepository() Tests if retrieving mappings of assets and repositories is supported.
boolean	supportsAssetRepositoryAssignment() Tests if managing mappings of assets and repositories is supported.
boolean	supportsAssetSearch() Tests if asset search is supported.
boolean	supportsAssetSearchRecordType(Type assetSearchRecordType) Tests if a given asset search record type is supported.
boolean	supportsAssetSmartRepository() Tests if asset smart repository is supported.
boolean	supportsAssetSpatial() Tests if retrieving mappings of assets and spatial coverage is supported.
boolean	supportsAssetSpatialAssignment() Tests if managing mappings of assets and spatial ocverage is supported.
boolean	supportsAssetTemporal() Tests if retrieving mappings of assets and time coverage is supported.
boolean	supportsAssetTemporalAssignment() Tests if managing mappings of assets and time ocverage is supported.
boolean	supportsCompositionAdmin() Tests if composition administration is supported.
boolean	supportsCompositionLookup() Tests if composition lookup is supported.
boolean	supportsCompositionNotification() Tests if composition notification is supported.
boolean	supportsCompositionQuery() Tests if composition query is supported.
boolean	supportsCompositionRecordType(Type compositionRecordType) Tests if a given composition record type is supported.
boolean	supportsCompositionRepository() Tests if retrieval of composition to repository mappings is supported.
boolean	supportsCompositionRepositoryAssignment() Tests if assigning composition to repository mappings is supported.
boolean	supportsCompositionSearch() Tests if composition search is supported.
boolean	supportsCompositionSearchRecordType(Type compositionSearchRecordType) Tests if a given composition search record type is supported.
boolean	supportsCompositionSmartRepository() Tests if composition smart repository is supported.
boolean	supportsCoordinateType(Type coordinateType) Tests if a given coordinate type is supported.
boolean	supportsRepositoryAdmin() Tests if repository administration is supported.
boolean	supportsRepositoryBatch() Tests if a repository batch service is supported.
boolean	supportsRepositoryHierarchy() Tests if a repository hierarchy traversal is supported.
boolean	supportsRepositoryHierarchyDesign() Tests if a repository hierarchy design is supported.
boolean	supportsRepositoryLookup() Tests if repository lookup is supported.
boolean	supportsRepositoryNotification() Tests if repository notification is supported.
boolean	supportsRepositoryQuery() Tests if repository query is supported.
boolean	supportsRepositoryRecordType(Type repositoryRecordType) Tests if a given repository record type is supported.
boolean	supportsRepositoryRules() Tests if a repository rules service is supported.
boolean	supportsRepositorySearch() Tests if repository search is supported.
boolean	supportsRepositorySearchRecordType(Type repositorySearchRecordType) Tests if a given repository search record type is supported.
boolean	supportsSpatialUnitRecordType(Type spatialUnitRecordType) Tests if a given spatial unit record type is supported.
boolean	supportsVisibleFederation() Tests if federation is visible.

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetLookup

boolean supportsAssetLookup()

Tests if asset lookup is supported.

Returns:

true if asset lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetQuery

boolean supportsAssetQuery()

Tests if asset query is supported.

Returns:

true if asset query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetSearch

boolean supportsAssetSearch()

Tests if asset search is supported.

Returns:

true if asset search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetAdmin

boolean supportsAssetAdmin()

Tests if asset administration is supported.

Returns:

true if asset administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetNotification

boolean supportsAssetNotification()

Tests if asset notification is supported. A repository may send messages when assets are created, modified, or deleted.

Returns:

true if asset notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetRepository

boolean supportsAssetRepository()

Tests if retrieving mappings of assets and repositories is supported.

Returns:

true if asset repository mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetRepositoryAssignment

boolean supportsAssetRepositoryAssignment()

Tests if managing mappings of assets and repositories is supported.

Returns:

true if asset repository assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetSmartRepository

boolean supportsAssetSmartRepository()

Tests if asset smart repository is supported.

Returns:

true if asset smart repository is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetTemporal

boolean supportsAssetTemporal()

Tests if retrieving mappings of assets and time coverage is supported.

Returns:

true if asset temporal mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetTemporalAssignment

boolean supportsAssetTemporalAssignment()

Tests if managing mappings of assets and time ocverage is supported.

Returns:

true if asset temporal assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetSpatial

boolean supportsAssetSpatial()

Tests if retrieving mappings of assets and spatial coverage is supported.

Returns:

true if asset spatial mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetSpatialAssignment

boolean supportsAssetSpatialAssignment()

Tests if managing mappings of assets and spatial ocverage is supported.

Returns:

true if asset spatial assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetComposition

boolean supportsAssetComposition()

Tests if assets are included in compositions.

Returns:

true if asset composition supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAssetCompositionDesign

boolean supportsAssetCompositionDesign()

Tests if mapping assets to compositions is supported.

Returns:

true if designing asset compositions is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionLookup

boolean supportsCompositionLookup()

Tests if composition lookup is supported.

Returns:

true if composition lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionQuery

boolean supportsCompositionQuery()

Tests if composition query is supported.

Returns:

true if composition query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionSearch

boolean supportsCompositionSearch()

Tests if composition search is supported.

Returns:

true if composition search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionAdmin

boolean supportsCompositionAdmin()

Tests if composition administration is supported.

Returns:

true if composition administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionNotification

boolean supportsCompositionNotification()

Tests if composition notification is supported.

Returns:

true if composition notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionRepository

boolean supportsCompositionRepository()

Tests if retrieval of composition to repository mappings is supported.

Returns:

true if composition to repository mapping is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionRepositoryAssignment

boolean supportsCompositionRepositoryAssignment()

Tests if assigning composition to repository mappings is supported.

Returns:

true if composition to repository assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCompositionSmartRepository

boolean supportsCompositionSmartRepository()

Tests if composition smart repository is supported.

Returns:

true if composition smart repository is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryLookup

boolean supportsRepositoryLookup()

Tests if repository lookup is supported.

Returns:

true if repository lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryQuery

boolean supportsRepositoryQuery()

Tests if repository query is supported.

Returns:

true if repository query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositorySearch

boolean supportsRepositorySearch()

Tests if repository search is supported.

Returns:

true if repository search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryAdmin

boolean supportsRepositoryAdmin()

Tests if repository administration is supported.

Returns:

true if repository administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryNotification

boolean supportsRepositoryNotification()

Tests if repository notification is supported. Messages may be sent when Repository objects are created, deleted or updated. Notifications for assets within repositories are sent via the asset notification session.

Returns:

true if repository notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryHierarchy

boolean supportsRepositoryHierarchy()

Tests if a repository hierarchy traversal is supported.

Returns:

true if a repository hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryHierarchyDesign

boolean supportsRepositoryHierarchyDesign()

Tests if a repository hierarchy design is supported.

Returns:

true if a repository hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryBatch

boolean supportsRepositoryBatch()

Tests if a repository batch service is supported.

Returns:

true if a repository batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRepositoryRules

boolean supportsRepositoryRules()

Tests if a repository rules service is supported.

Returns:

true if a repository rules service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssetRecordTypes

TypeList getAssetRecordTypes()

Gets all the asset record types supported.

Returns:

the list of supported asset record types

Compliance:

mandatory - This method must be implemented.

supportsAssetRecordType

boolean supportsAssetRecordType(Type assetRecordType)

Tests if a given asset type is supported.

Parameters:

assetRecordType - the asset record type

Returns:

true if the asset record type is supported , false otherwise

Throws:

NullArgumentException - assetRecordType is null

Compliance:

mandatory - This method must be implemented.

getAssetSearchRecordTypes

TypeList getAssetSearchRecordTypes()

Gets all the asset search record types supported.

Returns:

the list of supported asset search record types

Compliance:

mandatory - This method must be implemented.

supportsAssetSearchRecordType

boolean supportsAssetSearchRecordType(Type assetSearchRecordType)

Tests if a given asset search record type is supported.

Parameters:

assetSearchRecordType - the asset search record type

Returns:

true if the asset search record type is supported , false otherwise

Throws:

NullArgumentException - assetSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAssetContentRecordTypes

TypeList getAssetContentRecordTypes()

Gets all the asset content record types supported.

Returns:

the list of supported asset content record types

Compliance:

mandatory - This method must be implemented.

supportsAssetContentRecordType

boolean supportsAssetContentRecordType(Type assetContentRecordType)

Tests if a given asset content record type is supported.

Parameters:

assetContentRecordType - the asset content record type

Returns:

true if the asset content record type is supported , false otherwise

Throws:

NullArgumentException - assetContentRecordType is null

Compliance:

mandatory - This method must be implemented.

getCompositionRecordTypes

TypeList getCompositionRecordTypes()

Gets all the composition record types supported.

Returns:

the list of supported composition record types

Compliance:

mandatory - This method must be implemented.

supportsCompositionRecordType

boolean supportsCompositionRecordType(Type compositionRecordType)

Tests if a given composition record type is supported.

Parameters:

compositionRecordType - the composition record type

Returns:

true if the composition record type is supported , false otherwise

Throws:

NullArgumentException - compositionRecordType is null

Compliance:

mandatory - This method must be implemented.

getCompositionSearchRecordTypes

TypeList getCompositionSearchRecordTypes()

Gets all the composition search record types supported.

Returns:

the list of supported composition search record types

Compliance:

mandatory - This method must be implemented.

supportsCompositionSearchRecordType

boolean supportsCompositionSearchRecordType(Type compositionSearchRecordType)

Tests if a given composition search record type is supported.

Parameters:

compositionSearchRecordType - the composition serach type

Returns:

true if the composition search record type is supported , false otherwise

Throws:

NullArgumentException - compositionSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getRepositoryRecordTypes

TypeList getRepositoryRecordTypes()

Gets all the repository record types supported.

Returns:

the list of supported repository record types

Compliance:

mandatory - This method must be implemented.

supportsRepositoryRecordType

boolean supportsRepositoryRecordType(Type repositoryRecordType)

Tests if a given repository record type is supported.

Parameters:

repositoryRecordType - the repository record type

Returns:

true if the repository record type is supported , false otherwise

Throws:

NullArgumentException - repositoryRecordType is null

Compliance:

mandatory - This method must be implemented.

getRepositorySearchRecordTypes

TypeList getRepositorySearchRecordTypes()

Gets all the repository search record types supported.

Returns:

the list of supported repository search record types

Compliance:

mandatory - This method must be implemented.

supportsRepositorySearchRecordType

boolean supportsRepositorySearchRecordType(Type repositorySearchRecordType)

Tests if a given repository search record type is supported.

Parameters:

repositorySearchRecordType - the repository search type

Returns:

true if the repository search record type is supported , false otherwise

Throws:

NullArgumentException - repositorySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getSpatialUnitRecordTypes

TypeList getSpatialUnitRecordTypes()

Gets all the spatial unit record types supported.

Returns:

the list of supported spatial unit record types

Compliance:

mandatory - This method must be implemented.

supportsSpatialUnitRecordType

boolean supportsSpatialUnitRecordType(Type spatialUnitRecordType)

Tests if a given spatial unit record type is supported.

Parameters:

spatialUnitRecordType - the spatial unit record type

Returns:

true if the spatial unit record type is supported , false otherwise

Throws:

NullArgumentException - spatialUnitRecordType is null

Compliance:

mandatory - This method must be implemented.

getCoordinateTypes

TypeList getCoordinateTypes()

Gets all the coordinate types supported.

Returns:

the list of supported coordinate types

Compliance:

mandatory - This method must be implemented.

supportsCoordinateType

boolean supportsCoordinateType(Type coordinateType)

Tests if a given coordinate type is supported.

Parameters:

coordinateType - the coordinate type

Returns:

true if the coordinate type is supported , false otherwise

Throws:

NullArgumentException - coordinateType is null

Compliance:

mandatory - This method must be implemented.