Interface RepositoryProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
RepositoryManager, RepositoryProxyManager
The repository profile describes interoperability among repository services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedAssetContentrecord types.Gets the supportedAssetContentsearch types.Gets all the asset record types supported.Gets all the asset search record types supported.Gets all the composition record types supported.Gets all the composition search record types supported.Gets all the coordinate types supported.Gets all the repository record types supported.Gets all the repository search record types supported.Gets all the spatial unit record types supported.booleanTests if asset administration is supported.booleanTests if assets are included in compositions.booleanTests if mapping assets to compositions is supported.booleanTests if an asset content administrative service is supported.booleanTests if looking up asset contents is supported.booleanTests if an asset content notification service is supported.booleanTests if querying asset contents is supported.booleansupportsAssetContentRecordType(Type assetContentRecordType) Tests if the givenAssetContentrecord type is supported.booleanTests if an asset content repository lookup service is supported.booleanTests if an asset content repository assignment service is supported.booleanTests if searching asset contents is supported.booleansupportsAssetContentSearchRecordType(Type assetContentSearchRecordType) Tests if the givenAssetContentsearch type is supported.booleanTests if an asset content smart repository service is supported.booleanTests if asset lookup is supported.booleanTests if asset notification is supported.booleanTests if asset query is supported.booleansupportsAssetRecordType(Type assetRecordType) Tests if a given asset type is supported.booleanTests if retrieving mappings of assets and repositories is supported.booleanTests if managing mappings of assets and repositories is supported.booleanTests if asset search is supported.booleansupportsAssetSearchRecordType(Type assetSearchRecordType) Tests if a given asset search record type is supported.booleanTests if asset smart repository is supported.booleanTests if retrieving mappings of assets and spatial coverage is supported.booleanTests if managing mappings of assets and spatial ocverage is supported.booleanTests if retrieving mappings of assets and time coverage is supported.booleanTests if managing mappings of assets and time ocverage is supported.booleanTests if composition administration is supported.booleanTests if composition lookup is supported.booleanTests if composition notification is supported.booleanTests if composition query is supported.booleansupportsCompositionRecordType(Type compositionRecordType) Tests if a given composition record type is supported.booleanTests if retrieval of composition to repository mappings is supported.booleanTests if assigning composition to repository mappings is supported.booleanTests if composition search is supported.booleansupportsCompositionSearchRecordType(Type compositionSearchRecordType) Tests if a given composition search record type is supported.booleanTests if composition smart repository is supported.booleansupportsCoordinateType(Type coordinateType) Tests if a given coordinate type is supported.booleanTests if repository administration is supported.booleanTests if a repository batch service is supported.booleanTests if a repository hierarchy traversal is supported.booleanTests if a repository hierarchy design is supported.booleanTests if repository lookup is supported.booleanTests if repository notification is supported.booleanTests if repository query is supported.booleansupportsRepositoryRecordType(Type repositoryRecordType) Tests if a given repository record type is supported.booleanTests if a repository rules service is supported.booleanTests if repository search is supported.booleansupportsRepositorySearchRecordType(Type repositorySearchRecordType) Tests if a given repository search record type is supported.booleansupportsSpatialUnitRecordType(Type spatialUnitRecordType) Tests if a given spatial unit record type is supported.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if federation is visible.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetLookup
boolean supportsAssetLookup()Tests if asset lookup is supported.- Returns:
trueif asset lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetQuery
boolean supportsAssetQuery()Tests if asset query is supported.- Returns:
trueif asset query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetSearch
boolean supportsAssetSearch()Tests if asset search is supported.- Returns:
trueif asset search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetAdmin
boolean supportsAssetAdmin()Tests if asset administration is supported.- Returns:
trueif asset administration is supported,falseotherwise- 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:
trueif asset notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetRepository
boolean supportsAssetRepository()Tests if retrieving mappings of assets and repositories is supported.- Returns:
trueif asset repository mapping retrieval is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetRepositoryAssignment
boolean supportsAssetRepositoryAssignment()Tests if managing mappings of assets and repositories is supported.- Returns:
trueif asset repository assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetSmartRepository
boolean supportsAssetSmartRepository()Tests if asset smart repository is supported.- Returns:
trueif asset smart repository is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetTemporal
boolean supportsAssetTemporal()Tests if retrieving mappings of assets and time coverage is supported.- Returns:
trueif asset temporal mapping retrieval is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetTemporalAssignment
boolean supportsAssetTemporalAssignment()Tests if managing mappings of assets and time ocverage is supported.- Returns:
trueif asset temporal assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetSpatial
boolean supportsAssetSpatial()Tests if retrieving mappings of assets and spatial coverage is supported.- Returns:
trueif asset spatial mapping retrieval is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetSpatialAssignment
boolean supportsAssetSpatialAssignment()Tests if managing mappings of assets and spatial ocverage is supported.- Returns:
trueif asset spatial assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetComposition
boolean supportsAssetComposition()Tests if assets are included in compositions.- Returns:
trueif asset composition supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetCompositionDesign
boolean supportsAssetCompositionDesign()Tests if mapping assets to compositions is supported.- Returns:
trueif designing asset compositions is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentLookup
boolean supportsAssetContentLookup()Tests if looking up asset contents is supported.- Returns:
trueif asset content lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentQuery
boolean supportsAssetContentQuery()Tests if querying asset contents is supported.- Returns:
trueif asset content query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentSearch
boolean supportsAssetContentSearch()Tests if searching asset contents is supported.- Returns:
trueif asset content search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentAdmin
boolean supportsAssetContentAdmin()Tests if an asset content administrative service is supported.- Returns:
trueif asset content administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentNotification
boolean supportsAssetContentNotification()Tests if an asset content notification service is supported.- Returns:
trueif asset content notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentRepository
boolean supportsAssetContentRepository()Tests if an asset content repository lookup service is supported.- Returns:
trueif an asset content repository lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentRepositoryAssignment
boolean supportsAssetContentRepositoryAssignment()Tests if an asset content repository assignment service is supported.- Returns:
trueif an asset content to repository assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentSmartRepository
boolean supportsAssetContentSmartRepository()Tests if an asset content smart repository service is supported.- Returns:
trueif an smart repository service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionLookup
boolean supportsCompositionLookup()Tests if composition lookup is supported.- Returns:
trueif composition lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionQuery
boolean supportsCompositionQuery()Tests if composition query is supported.- Returns:
trueif composition query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionSearch
boolean supportsCompositionSearch()Tests if composition search is supported.- Returns:
trueif composition search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionAdmin
boolean supportsCompositionAdmin()Tests if composition administration is supported.- Returns:
trueif composition administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionNotification
boolean supportsCompositionNotification()Tests if composition notification is supported.- Returns:
trueif composition notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionRepository
boolean supportsCompositionRepository()Tests if retrieval of composition to repository mappings is supported.- Returns:
trueif composition to repository mapping is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionRepositoryAssignment
boolean supportsCompositionRepositoryAssignment()Tests if assigning composition to repository mappings is supported.- Returns:
trueif composition to repository assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCompositionSmartRepository
boolean supportsCompositionSmartRepository()Tests if composition smart repository is supported.- Returns:
trueif composition smart repository is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryLookup
boolean supportsRepositoryLookup()Tests if repository lookup is supported.- Returns:
trueif repository lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryQuery
boolean supportsRepositoryQuery()Tests if repository query is supported.- Returns:
trueif repository query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositorySearch
boolean supportsRepositorySearch()Tests if repository search is supported.- Returns:
trueif repository search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryAdmin
boolean supportsRepositoryAdmin()Tests if repository administration is supported.- Returns:
trueif repository administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryNotification
boolean supportsRepositoryNotification()Tests if repository notification is supported. Messages may be sent whenRepositoryobjects are created, deleted or updated. Notifications for assets within repositories are sent via the asset notification session.- Returns:
trueif repository notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryHierarchy
boolean supportsRepositoryHierarchy()Tests if a repository hierarchy traversal is supported.- Returns:
trueif a repository hierarchy traversal is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryHierarchyDesign
boolean supportsRepositoryHierarchyDesign()Tests if a repository hierarchy design is supported.- Returns:
trueif a repository hierarchy design is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryBatch
boolean supportsRepositoryBatch()Tests if a repository batch service is supported.- Returns:
trueif a repository batch service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRepositoryRules
boolean supportsRepositoryRules()Tests if a repository rules service is supported.- Returns:
trueif a repository rules service is supported,falseotherwise- 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
Tests if a given asset type is supported.- Parameters:
assetRecordType- the asset record type- Returns:
trueif the asset record type is supported,falseotherwise- Throws:
NullArgumentException-assetRecordTypeisnull- 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
Tests if a given asset search record type is supported.- Parameters:
assetSearchRecordType- the asset search record type- Returns:
trueif the asset search record type is supported,falseotherwise- Throws:
NullArgumentException-assetSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAssetContentRecordTypes
TypeList getAssetContentRecordTypes()Gets the supportedAssetContentrecord types.- Returns:
- a list containing the supported
AssetContentrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentRecordType
Tests if the givenAssetContentrecord type is supported.- Parameters:
assetContentRecordType- aTypeindicating anAssetContentrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-assetContentRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAssetContentSearchRecordTypes
TypeList getAssetContentSearchRecordTypes()Gets the supportedAssetContentsearch types.- Returns:
- a list containing the supported
AssetContentsearch types - Compliance:
mandatory- This method must be implemented.
-
supportsAssetContentSearchRecordType
Tests if the givenAssetContentsearch type is supported.- Parameters:
assetContentSearchRecordType- aTypeindicating anAssetContentsearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-assetContentSearchRecordTypeisnull- 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
Tests if a given composition record type is supported.- Parameters:
compositionRecordType- the composition record type- Returns:
trueif the composition record type is supported,falseotherwise- Throws:
NullArgumentException-compositionRecordTypeisnull- 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
Tests if a given composition search record type is supported.- Parameters:
compositionSearchRecordType- the composition serach type- Returns:
trueif the composition search record type is supported,falseotherwise- Throws:
NullArgumentException-compositionSearchRecordTypeisnull- 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
Tests if a given repository record type is supported.- Parameters:
repositoryRecordType- the repository record type- Returns:
trueif the repository record type is supported,falseotherwise- Throws:
NullArgumentException-repositoryRecordTypeisnull- 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
Tests if a given repository search record type is supported.- Parameters:
repositorySearchRecordType- the repository search type- Returns:
trueif the repository search record type is supported,falseotherwise- Throws:
NullArgumentException-repositorySearchRecordTypeisnull- 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
Tests if a given spatial unit record type is supported.- Parameters:
spatialUnitRecordType- the spatial unit record type- Returns:
trueif the spatial unit record type is supported,falseotherwise- Throws:
NullArgumentException-spatialUnitRecordTypeisnull- 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
Tests if a given coordinate type is supported.- Parameters:
coordinateType- the coordinate type- Returns:
trueif the coordinate type is supported,falseotherwise- Throws:
NullArgumentException-coordinateTypeisnull- Compliance:
mandatory- This method must be implemented.
-