OSID - osid.repository.RepositoryProfile Service Interface Definition

Interface	osid.repository.RepositoryProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.repository.RepositoryManager`
Implemented By	`osid.repository.RepositoryProxyManager`
Description	The repository profile describes interoperability among repository services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetLookup
Description	Tests if asset lookup is supported.
Return	`boolean`		`true` if asset lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if asset query is supported.
Return	`boolean`		`true` if asset query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetSearch
Description	Tests if asset search is supported.
Return	`boolean`		`true` if asset search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetAdmin
Description	Tests if asset administration is supported.
Return	`boolean`		`true` if asset administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetNotification
Description	Tests if asset notification is supported. A repository may send messages when assets are created, modified, or deleted.
Return	`boolean`		`true` if asset notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetRepository
Description	Tests if retrieving mappings of assets and repositories is supported.
Return	`boolean`		`true` if asset repository mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetRepositoryAssignment
Description	Tests if managing mappings of assets and repositories is supported.
Return	`boolean`		`true` if asset repository assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetSmartRepository
Description	Tests if asset smart repository is supported.
Return	`boolean`		`true` if asset smart repository is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetTemporal
Description	Tests if retrieving mappings of assets and time coverage is supported.
Return	`boolean`		`true` if asset temporal mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetTemporalAssignment
Description	Tests if managing mappings of assets and time ocverage is supported.
Return	`boolean`		`true` if asset temporal assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetSpatial
Description	Tests if retrieving mappings of assets and spatial coverage is supported.
Return	`boolean`		`true` if asset spatial mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetSpatialAssignment
Description	Tests if managing mappings of assets and spatial ocverage is supported.
Return	`boolean`		`true` if asset spatial assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetComposition
Description	Tests if assets are included in compositions.
Return	`boolean`		`true` if asset composition supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetCompositionDesign
Description	Tests if mapping assets to compositions is supported.
Return	`boolean`		`true` if designing asset compositions is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentLookup
Description	Tests if looking up asset contents is supported.
Return	`boolean`		`true` if asset content lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentQuery
Description	Tests if querying asset contents is supported.
Return	`boolean`		`true` if asset content query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentSearch
Description	Tests if searching asset contents is supported.
Return	`boolean`		`true` if asset content search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentAdmin
Description	Tests if an asset content administrative service is supported.
Return	`boolean`		`true` if asset content administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentNotification
Description	Tests if an asset content notification service is supported.
Return	`boolean`		`true` if asset content notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentRepository
Description	Tests if an asset content repository lookup service is supported.
Return	`boolean`		`true` if an asset content repository lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentRepositoryAssignment
Description	Tests if an asset content repository assignment service is supported.
Return	`boolean`		`true` if an asset content to repository assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentSmartRepository
Description	Tests if an asset content smart repository service is supported.
Return	`boolean`		`true` if an smart repository service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionLookup
Description	Tests if composition lookup is supported.
Return	`boolean`		`true` if composition lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionQuery
Description	Tests if composition query is supported.
Return	`boolean`		`true` if composition query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionSearch
Description	Tests if composition search is supported.
Return	`boolean`		`true` if composition search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionAdmin
Description	Tests if composition administration is supported.
Return	`boolean`		`true` if composition administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionNotification
Description	Tests if composition notification is supported.
Return	`boolean`		`true` if composition notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionRepository
Description	Tests if retrieval of composition to repository mappings is supported.
Return	`boolean`		`true` if composition to repository mapping is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionRepositoryAssignment
Description	Tests if assigning composition to repository mappings is supported.
Return	`boolean`		`true` if composition to repository assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionSmartRepository
Description	Tests if composition smart repository is supported.
Return	`boolean`		`true` if composition smart repository is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryLookup
Description	Tests if repository lookup is supported.
Return	`boolean`		`true` if repository lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryQuery
Description	Tests if repository query is supported.
Return	`boolean`		`true` if repository query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositorySearch
Description	Tests if repository search is supported.
Return	`boolean`		`true` if repository search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryAdmin
Description	Tests if repository administration is supported.
Return	`boolean`		`true` if repository administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryNotification
Description	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.
Return	`boolean`		`true` if repository notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryHierarchy
Description	Tests if a repository hierarchy traversal is supported.
Return	`boolean`		`true` if a repository hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryHierarchyDesign
Description	Tests if a repository hierarchy design is supported.
Return	`boolean`		`true` if a repository hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryBatch
Description	Tests if a repository batch service is supported.
Return	`boolean`		`true` if a repository batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryRules
Description	Tests if a repository rules service is supported.
Return	`boolean`		`true` if a repository rules service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetRecordTypes
Description	Gets all the asset record types supported.
Return	`osid.type.TypeList`		the list of supported asset record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetRecordType
Description	Tests if a given asset type is supported.
Parameters	`osid.type.Type`	`assetRecordType`	the asset record type
Return	`boolean`		`true` if the asset record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetSearchRecordTypes
Description	Gets all the asset search record types supported.
Return	`osid.type.TypeList`		the list of supported asset search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetSearchRecordType
Description	Tests if a given asset search record type is supported.
Parameters	`osid.type.Type`	`assetSearchRecordType`	the asset search record type
Return	`boolean`		`true` if the asset search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentRecordTypes
Description	Gets the supported `AssetContent` record types.
Return	`osid.type.TypeList`		a list containing the supported `AssetContent` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentRecordType
Description	Tests if the given `AssetContent` record type is supported.
Parameters	`osid.type.Type`	`assetContentRecordType`	a `Type` indicating an `AssetContent` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetContentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentSearchRecordTypes
Description	Gets the supported `AssetContent` search types.
Return	`osid.type.TypeList`		a list containing the supported `AssetContent` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentSearchRecordType
Description	Tests if the given `AssetContent` search type is supported.
Parameters	`osid.type.Type`	`assetContentSearchRecordType`	a `Type` indicating an `AssetContent` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetContentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionRecordTypes
Description	Gets all the composition record types supported.
Return	`osid.type.TypeList`		the list of supported composition record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionRecordType
Description	Tests if a given composition record type is supported.
Parameters	`osid.type.Type`	`compositionRecordType`	the composition record type
Return	`boolean`		`true` if the composition record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`compositionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionSearchRecordTypes
Description	Gets all the composition search record types supported.
Return	`osid.type.TypeList`		the list of supported composition search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionSearchRecordType
Description	Tests if a given composition search record type is supported.
Parameters	`osid.type.Type`	`compositionSearchRecordType`	the composition serach type
Return	`boolean`		`true` if the composition search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`compositionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryRecordTypes
Description	Gets all the repository record types supported.
Return	`osid.type.TypeList`		the list of supported repository record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryRecordType
Description	Tests if a given repository record type is supported.
Parameters	`osid.type.Type`	`repositoryRecordType`	the repository record type
Return	`boolean`		`true` if the repository record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`repositoryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRepositorySearchRecordTypes
Description	Gets all the repository search record types supported.
Return	`osid.type.TypeList`		the list of supported repository search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositorySearchRecordType
Description	Tests if a given repository search record type is supported.
Parameters	`osid.type.Type`	`repositorySearchRecordType`	the repository search type
Return	`boolean`		`true` if the repository search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`repositorySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpatialUnitRecordTypes
Description	Gets all the spatial unit record types supported.
Return	`osid.type.TypeList`		the list of supported spatial unit record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpatialUnitRecordType
Description	Tests if a given spatial unit record type is supported.
Parameters	`osid.type.Type`	`spatialUnitRecordType`	the spatial unit record type
Return	`boolean`		`true` if the spatial unit record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`spatialUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateTypes
Description	Gets all the coordinate types supported.
Return	`osid.type.TypeList`		the list of supported coordinate types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateType
Description	Tests if a given coordinate type is supported.
Parameters	`osid.type.Type`	`coordinateType`	the coordinate type
Return	`boolean`		`true` if the coordinate type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`coordinateType` is `null`
Compliance	`mandatory`		This method must be implemented.