public interface CatalogingProfile extends OsidProfile
The cataloging profile describes the interoperability among cataloging services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getCatalogRecordTypes()
Gets the supported
Catalog record types. |
TypeList |
getCatalogSearchRecordTypes()
Gets the supported catalog search reciord types.
|
boolean |
supportsCatalog()
Tests for the availability of a cataloging service retrieving
Id to Catalog mappings. |
boolean |
supportsCatalogAdmin()
Tests for the availability of a catalog administration service for the
addition and deletion of catalogs.
|
boolean |
supportsCatalogAssignment()
Tests for the availability of a cataloging service for mapping
Ids to Catalogs. |
boolean |
supportsCatalogEntryNotification()
Tests for the availability of a cataloging notification service for
mapping
Ids to Catalogs. |
boolean |
supportsCatalogHierarchy()
Tests for the availability of a catalog hierarchy traversal service.
|
boolean |
supportsCatalogHierarchyDesign()
Tests for the availability of a catalog hierarchy design service.
|
boolean |
supportsCatalogingRules()
Tests if the cataloging rules sub services is supported.
|
boolean |
supportsCatalogLookup()
Tests for the availability of a catalog lookup service.
|
boolean |
supportsCatalogNotification()
Tests for the availability of a catalog notification service.
|
boolean |
supportsCatalogQuery()
Tests for the availability of a catalog query service that defines
more comprehensive queries.
|
boolean |
supportsCatalogRecordType(Type catalogRecordType)
Tests if the given
Catalog record type is supported. |
boolean |
supportsCatalogSearch()
Tests for the availability of a catalog search service that defines
more comprehensive queries.
|
boolean |
supportsCatalogSearchRecordType(Type catalogSearchRecordType)
Tests if the given catalog search record type is supported.
|
boolean |
supportsVisibleFederation()
Tests if any billing federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalog()
Id
to Catalog
mappings. true
if cataloging is available, false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogAssignment()
Ids
to Catalogs.
true
if catalog assignment is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogEntryNotification()
Ids
to Catalogs.
true
if catalog entry notification is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogLookup()
true
if catalog lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogQuery()
true
if catalog query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogSearch()
true
if catalog search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogAdmin()
true
if catalog administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogNotification()
true
if catalog notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogHierarchy()
true
if catalog hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogHierarchyDesign()
true
if catalog hierarchy design is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsCatalogingRules()
true
if cataloging rules is supported,
false
otherwisemandatory
- This method must be implemented. TypeList getCatalogRecordTypes()
Catalog
record types. Catalog
record
typesmandatory
- This method must be implemented. boolean supportsCatalogRecordType(Type catalogRecordType)
Catalog
record type is supported.catalogRecordType
- a Type
indicating a
Catalog
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- catalogRecordType
is null
mandatory
- This method must be implemented. TypeList getCatalogSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsCatalogSearchRecordType(Type catalogSearchRecordType)
catalogSearchRecordType
- a Type
indicating a
catalog search record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- catalogSearchRecordType
is null
mandatory
- This method must be implemented.