org.osid.installation

Interface InstallationProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

InstallationManager, InstallationProxyManager

public interface InstallationProfile
extends OsidProfile

The InstallationProfile describes the interoperability among installation services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getDepotRecordTypes() Gets the supported Depot record types.
TypeList	getDepotSearchRecordTypes() Gets the supported depot search record types.
TypeList	getInstallationContentRecordTypes() Gets the supported InstallationContent record types.
TypeList	getInstallationRecordTypes() Gets the supported Installation record types.
TypeList	getInstallationSearchRecordTypes() Gets the supported Installation search record types.
TypeList	getPackageRecordTypes() Gets the supported Package record types.
TypeList	getPackageSearchRecordTypes() Gets the supported Package search record types.
TypeList	getSiteRecordTypes() Gets the supported Site record types.
boolean	supportsDepotAdmin() Tests if a depot administrative service is supported.
boolean	supportsDepotHierarchy() Tests if a depot hierarchy traversal is supported.
boolean	supportsDepotHierarchyDesign() Tests if depot hierarchy design is supported.
boolean	supportsDepotLookup() Tests if a depot lookup service is supported.
boolean	supportsDepotNotification() Tests if depot notification is supported.
boolean	supportsDepotQuery() Tests if a depot query service is supported.
boolean	supportsDepotRecordType(Type depotRecordType) Tests if the given Depot record type is supported.
boolean	supportsDepotSearch() Tests if a depot search service is supported.
boolean	supportsDepotSearchRecordType(Type depotSearchRecordType) Tests if the given depot search record type is supported.
boolean	supportsInstallationBatch() Tests if an installation batch service is supported.
boolean	supportsInstallationContentRecordType(Type installationContentRecordType) Tests if the given InstallationContent record type is supported.
boolean	supportsInstallationLookup() Tests if an installation lookup service is supported.
boolean	supportsInstallationManagement() Tests if an installation management service is supported.
boolean	supportsInstallationNotification() Tests if installation notification is supported.
boolean	supportsInstallationQuery() Tests if an installation query service is supported.
boolean	supportsInstallationRecordType(Type installationRecordType) Tests if the given Installation record type is supported.
boolean	supportsInstallationSearch() Tests if an installation search service is supported.
boolean	supportsInstallationSearchRecordType(Type installationSearchRecordType) Tests if the given Installation search record type is supported.
boolean	supportsInstallationUpdate() Tests if an installation update service is supported.
boolean	supportsPackageAdmin() Tests if a package administrative service is supported.
boolean	supportsPackageDepot() Tests if a package to depot lookup session is available.
boolean	supportsPackageDepotAssignment() Tests if a package to depot assignment session is available.
boolean	supportsPackageLookup() Tests if a package lookup service is supported.
boolean	supportsPackageNotification() Tests if package notification is supported.
boolean	supportsPackageQuery() Tests if querying packages is supported.
boolean	supportsPackageRecordType(Type packageRecordType) Tests if the given Package record type is supported.
boolean	supportsPackageSearch() Tests if a package search service is supported.
boolean	supportsPackageSearchRecordType(Type packageSearchRecordType) Tests if the given Package search record type is supported.
boolean	supportsPackageSmartDepot() Tests if package smart depots are available.
boolean	supportsSiteLookup() Tests if a site lookup service is supported.
boolean	supportsSiteRecordType(Type siteRecordType) Tests if the given Site 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.

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:

true if installation search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInstallationManagement

boolean supportsInstallationManagement()

Tests if an installation management service is supported.

Returns:

true if package management is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInstallationUpdate

boolean supportsInstallationUpdate()

Tests if an installation update service is supported.

Returns:

true if package update is supported, false otherwise

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:

true if installation notification is supported, false otherwise

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:

true if packages query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPackageSearch

boolean supportsPackageSearch()

Tests if a package search service is supported.

Returns:

true if package search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPackageAdmin

boolean supportsPackageAdmin()

Tests if a package administrative service is supported.

Returns:

true if package admin is supported, false otherwise

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:

true if package notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPackageDepot

boolean supportsPackageDepot()

Tests if a package to depot lookup session is available.

Returns:

true if package depot lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPackageDepotAssignment

boolean supportsPackageDepotAssignment()

Tests if a package to depot assignment session is available.

Returns:

true if package depot assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPackageSmartDepot

boolean supportsPackageSmartDepot()

Tests if package smart depots are available.

Returns:

true if package smart depots are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotLookup

boolean supportsDepotLookup()

Tests if a depot lookup service is supported.

Returns:

true if depot lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotQuery

boolean supportsDepotQuery()

Tests if a depot query service is supported.

Returns:

true if depot query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotSearch

boolean supportsDepotSearch()

Tests if a depot search service is supported.

Returns:

true if depot search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotAdmin

boolean supportsDepotAdmin()

Tests if a depot administrative service is supported.

Returns:

true if depot admin is supported, false otherwise

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:

true if depot notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotHierarchy

boolean supportsDepotHierarchy()

Tests if a depot hierarchy traversal is supported.

Returns:

true if a depot hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDepotHierarchyDesign

boolean supportsDepotHierarchyDesign()

Tests if depot hierarchy design is supported.

Returns:

true if a depot hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInstallationBatch

boolean supportsInstallationBatch()

Tests if an installation batch service is supported.

Returns:

true if an installation batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getInstallationRecordTypes

TypeList getInstallationRecordTypes()

Gets the supported Installation record types.

Returns:

a list containing the supported Installation record types

Compliance:

mandatory - This method must be implemented.

supportsInstallationRecordType

boolean supportsInstallationRecordType(Type installationRecordType)

Tests if the given Installation record type is supported.

Parameters:

installationRecordType - a Type indicating an Installation record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - installationRecordType is null

Compliance:

mandatory - This method must be implemented.

getInstallationSearchRecordTypes

TypeList getInstallationSearchRecordTypes()

Gets the supported Installation search record types.

Returns:

a list containing the supported Installation search record types

Compliance:

mandatory - This method must be implemented.

supportsInstallationSearchRecordType

boolean supportsInstallationSearchRecordType(Type installationSearchRecordType)

Tests if the given Installation search record type is supported.

Parameters:

installationSearchRecordType - a Type indicating an Installation search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - installationSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getSiteRecordTypes

TypeList getSiteRecordTypes()

Gets the supported Site record types.

Returns:

a list containing the supported Site record types

Compliance:

mandatory - This method must be implemented.

supportsSiteRecordType

boolean supportsSiteRecordType(Type siteRecordType)

Tests if the given Site record type is supported.

Parameters:

siteRecordType - a Type indicating a Site record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - siteRecordType is null

Compliance:

mandatory - This method must be implemented.

getPackageRecordTypes

TypeList getPackageRecordTypes()

Gets the supported Package record types.

Returns:

a list containing the supported Package record types

Compliance:

mandatory - This method must be implemented.

supportsPackageRecordType

boolean supportsPackageRecordType(Type packageRecordType)

Tests if the given Package record type is supported.

Parameters:

packageRecordType - a Type indicating a Package record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - packageRecordType is null

Compliance:

mandatory - This method must be implemented.

getPackageSearchRecordTypes

TypeList getPackageSearchRecordTypes()

Gets the supported Package search record types.

Returns:

a list containing the supported Package search record types

Compliance:

mandatory - This method must be implemented.

supportsPackageSearchRecordType

boolean supportsPackageSearchRecordType(Type packageSearchRecordType)

Tests if the given Package search record type is supported.

Parameters:

packageSearchRecordType - a Type indicating a Package search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - packageSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getInstallationContentRecordTypes

TypeList getInstallationContentRecordTypes()

Gets the supported InstallationContent record types.

Returns:

a list containing the supported InstallationContent record types

Compliance:

mandatory - This method must be implemented.

supportsInstallationContentRecordType

boolean supportsInstallationContentRecordType(Type installationContentRecordType)

Tests if the given InstallationContent record type is supported.

Parameters:

installationContentRecordType - a Type indicating an InstallationContent record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - installationContentRecordType is null

Compliance:

mandatory - This method must be implemented.

getDepotRecordTypes

TypeList getDepotRecordTypes()

Gets the supported Depot record types.

Returns:

a list containing the supported Depot record types

Compliance:

mandatory - This method must be implemented.

supportsDepotRecordType

boolean supportsDepotRecordType(Type depotRecordType)

Tests if the given Depot record type is supported.

Parameters:

depotRecordType - a Type indicating a Depot type

Returns:

true if the given depot record Type is supported, false otherwise

Throws:

NullArgumentException - depotRecordType is null

Compliance:

mandatory - This method must be implemented.

getDepotSearchRecordTypes

TypeList getDepotSearchRecordTypes()

Gets the supported depot search record types.

Returns:

a list containing the supported Depot search record types

Compliance:

mandatory - This method must be implemented.

supportsDepotSearchRecordType

boolean supportsDepotSearchRecordType(Type depotSearchRecordType)

Tests if the given depot search record type is supported.

Parameters:

depotSearchRecordType - a Type indicating a Depot search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - depotSearchRecordType is null

Compliance:

mandatory - This method must be implemented.