Interface InstallationProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
InstallationManager, InstallationProxyManager
The InstallationProfile describes the interoperability among
installation services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedDepotrecord types.Gets the supported depot search record types.Gets the supportedInstallationContentrecord types.Gets the supportedInstallationrecord types.Gets the supportedInstallationsearch record types.Gets the supportedPackagerecord types.Gets the supportedPackagesearch record types.Gets the supportedSiterecord types.booleanTests if a depot administrative service is supported.booleanTests if a depot hierarchy traversal is supported.booleanTests if depot hierarchy design is supported.booleanTests if a depot lookup service is supported.booleanTests if depot notification is supported.booleanTests if a depot query service is supported.booleansupportsDepotRecordType(Type depotRecordType) Tests if the givenDepotrecord type is supported.booleanTests if a depot search service is supported.booleansupportsDepotSearchRecordType(Type depotSearchRecordType) Tests if the given depot search record type is supported.booleanTests if an installation batch service is supported.booleansupportsInstallationContentRecordType(Type installationContentRecordType) Tests if the givenInstallationContentrecord type is supported.booleanTests if an installation lookup service is supported.booleanTests if an installation management service is supported.booleanTests if installation notification is supported.booleanTests if an installation query service is supported.booleansupportsInstallationRecordType(Type installationRecordType) Tests if the givenInstallationrecord type is supported.booleanTests if an installation search service is supported.booleansupportsInstallationSearchRecordType(Type installationSearchRecordType) Tests if the givenInstallationsearch record type is supported.booleanTests if an installation update service is supported.booleanTests if a package administrative service is supported.booleanTests if a package to depot lookup session is available.booleanTests if a package to depot assignment session is available.booleanTests if a package lookup service is supported.booleanTests if package notification is supported.booleanTests if querying packages is supported.booleansupportsPackageRecordType(Type packageRecordType) Tests if the givenPackagerecord type is supported.booleanTests if a package search service is supported.booleansupportsPackageSearchRecordType(Type packageSearchRecordType) Tests if the givenPackagesearch record type is supported.booleanTests if package smart depots are available.booleanTests if a site lookup service is supported.booleansupportsSiteRecordType(Type siteRecordType) Tests if the givenSiterecord 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.
-
supportsInstallationLookup
boolean supportsInstallationLookup()Tests if an installation lookup service is supported.- Returns:
- true if installation lookup is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationQuery
boolean supportsInstallationQuery()Tests if an installation query service is supported.- Returns:
- true if installation query is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationSearch
boolean supportsInstallationSearch()Tests if an installation search service is supported.- Returns:
trueif installation search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationManagement
boolean supportsInstallationManagement()Tests if an installation management service is supported.- Returns:
trueif package management is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationUpdate
boolean supportsInstallationUpdate()Tests if an installation update service is supported.- Returns:
trueif package update is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationNotification
boolean supportsInstallationNotification()Tests if installation notification is supported. Messages may be sent when installations are installed or removed.- Returns:
trueif installation notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSiteLookup
boolean supportsSiteLookup()Tests if a site lookup service is supported.- Returns:
- true if site lookup is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsPackageLookup
boolean supportsPackageLookup()Tests if a package lookup service is supported. A package lookup service defines methods to access packages.- Returns:
- true if package lookup is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsPackageQuery
boolean supportsPackageQuery()Tests if querying packages is supported.- Returns:
trueif packages query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageSearch
boolean supportsPackageSearch()Tests if a package search service is supported.- Returns:
trueif package search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageAdmin
boolean supportsPackageAdmin()Tests if a package administrative service is supported.- Returns:
trueif package admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageNotification
boolean supportsPackageNotification()Tests if package notification is supported. Messages may be sent when packages are created, modified, or deleted.- Returns:
trueif package notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageDepot
boolean supportsPackageDepot()Tests if a package to depot lookup session is available.- Returns:
trueif package depot lookup session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageDepotAssignment
boolean supportsPackageDepotAssignment()Tests if a package to depot assignment session is available.- Returns:
trueif package depot assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsPackageSmartDepot
boolean supportsPackageSmartDepot()Tests if package smart depots are available.- Returns:
trueif package smart depots are supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotLookup
boolean supportsDepotLookup()Tests if a depot lookup service is supported.- Returns:
trueif depot lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotQuery
boolean supportsDepotQuery()Tests if a depot query service is supported.- Returns:
trueif depot query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotSearch
boolean supportsDepotSearch()Tests if a depot search service is supported.- Returns:
trueif depot search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotAdmin
boolean supportsDepotAdmin()Tests if a depot administrative service is supported.- Returns:
trueif depot admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotNotification
boolean supportsDepotNotification()Tests if depot notification is supported. Messages may be sent when depots are created, modified, or deleted.- Returns:
trueif depot notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotHierarchy
boolean supportsDepotHierarchy()Tests if a depot hierarchy traversal is supported.- Returns:
trueif a depot hierarchy traversal is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDepotHierarchyDesign
boolean supportsDepotHierarchyDesign()Tests if depot hierarchy design is supported.- Returns:
trueif a depot hierarchy design is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstallationBatch
boolean supportsInstallationBatch()Tests if an installation batch service is supported.- Returns:
trueif an installation batch service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getInstallationRecordTypes
TypeList getInstallationRecordTypes()Gets the supportedInstallationrecord types.- Returns:
- a list containing the supported
Installationrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsInstallationRecordType
Tests if the givenInstallationrecord type is supported.- Parameters:
installationRecordType- aTypeindicating anInstallationrecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-installationRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInstallationSearchRecordTypes
TypeList getInstallationSearchRecordTypes()Gets the supportedInstallationsearch record types.- Returns:
- a list containing the supported
Installationsearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsInstallationSearchRecordType
Tests if the givenInstallationsearch record type is supported.- Parameters:
installationSearchRecordType- aTypeindicating anInstallationsearch record type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-installationSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getSiteRecordTypes
TypeList getSiteRecordTypes()Gets the supportedSiterecord types.- Returns:
- a list containing the supported
Siterecord types - Compliance:
mandatory- This method must be implemented.
-
supportsSiteRecordType
Tests if the givenSiterecord type is supported.- Parameters:
siteRecordType- aTypeindicating aSiterecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-siteRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getPackageRecordTypes
TypeList getPackageRecordTypes()Gets the supportedPackagerecord types.- Returns:
- a list containing the supported
Packagerecord types - Compliance:
mandatory- This method must be implemented.
-
supportsPackageRecordType
Tests if the givenPackagerecord type is supported.- Parameters:
packageRecordType- aTypeindicating aPackagerecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-packageRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getPackageSearchRecordTypes
TypeList getPackageSearchRecordTypes()Gets the supportedPackagesearch record types.- Returns:
- a list containing the supported
Packagesearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsPackageSearchRecordType
Tests if the givenPackagesearch record type is supported.- Parameters:
packageSearchRecordType- aTypeindicating aPackagesearch record type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-packageSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInstallationContentRecordTypes
TypeList getInstallationContentRecordTypes()Gets the supportedInstallationContentrecord types.- Returns:
- a list containing the supported
InstallationContentrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsInstallationContentRecordType
Tests if the givenInstallationContentrecord type is supported.- Parameters:
installationContentRecordType- aTypeindicating anInstallationContentrecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-installationContentRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getDepotRecordTypes
TypeList getDepotRecordTypes()Gets the supportedDepotrecord types.- Returns:
- a list containing the supported
Depotrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsDepotRecordType
Tests if the givenDepotrecord type is supported.- Parameters:
depotRecordType- aTypeindicating aDepottype- Returns:
trueif the given depot recordTypeis supported,falseotherwise- Throws:
NullArgumentException-depotRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getDepotSearchRecordTypes
TypeList getDepotSearchRecordTypes()Gets the supported depot search record types.- Returns:
- a list containing the supported
Depotsearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsDepotSearchRecordType
Tests if the given depot search record type is supported.- Parameters:
depotSearchRecordType- aTypeindicating aDepotsearch record type- Returns:
trueif the given search recordTypeis supported,falseotherwise- Throws:
NullArgumentException-depotSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-