public interface IDfSearchMetadataManager extends IDfSearchSourceContainer
Modifier and Type | Method and Description |
---|---|
java.lang.String |
convertDocbaseToMimeFormat(java.lang.String docbaseFormat)
Converts a repository format value to MIME format value.
|
java.lang.String |
convertMimeToDocbaseFormat(java.lang.String mimeFormat)
Converts a MIME format value to repository format value.
|
IDfEnumeration |
getAvailableTypes()
Provides an enumeration of available searchable types.
|
IDfEnumeration |
getAvailableTypes(boolean includeObsoleteTypes)
Provides an enumeration of available searchable types derived from a specified base type.
|
IDfEnumeration |
getAvailableTypes(java.lang.String baseType)
Provides an enumeration available types derived from a specified base type.
|
IDfEnumeration |
getAvailableTypes(java.lang.String baseType,
boolean includeObsoleteTypes)
Provides an enumeration available types derived from a specified base type.
|
java.lang.String |
getDefaultTypeName()
Provides access to the default type selection.
|
IDfList |
getDOSExtensions(java.lang.String mimeFormat)
Gets the DOS extensions associated to the specified MIME format value in the repository.
|
java.lang.String |
getMetadataDocbase()
Gets the repository to pick the metadata information from information on types.
|
IDfSessionManager |
getSessionMgr()
Provides access to an internal instance of the Session Manager.
|
IDfSearchSourceMap |
getSourceMap()
Provides convenient access to an internal reference of the source map.
|
IDfSearchTypeAssistant |
getTypeAssistant(java.lang.String typeName)
Provides access to a type assistant for the given type.
|
IDfSearchTypeAssistant |
getTypeAssistant(java.lang.String typeName,
boolean includeObsoleteTypes)
Provides access to a type assistant for the given type.
|
boolean |
isFulltextCompliant()
Informs if manager is in a full-text compliant mode.
|
void |
setFulltextCompliant(boolean fulltextCompliant)
Switches the compliance mode for supporting only full-text compliant constructs.
|
addSelectedSource, clearSelectedSources, getSelectedSourceCount, getSelectedSources, removeSelectedSource
IDfSessionManager getSessionMgr()
IDfSearchSourceMap getSourceMap()
boolean isFulltextCompliant()
true
, if full-text compliance is requested; false
otherwise.void setFulltextCompliant(boolean fulltextCompliant)
fulltextCompliant
- true
if full-text compliance is requested; false
otherwise.java.lang.String getMetadataDocbase() throws DfException
DfException
- If the default metadata server repository is searched for but not available (the default
metadata server repository is required when only external sources have been selected through
the search service).IDfEnumeration getAvailableTypes() throws DfException
DfException
- If an error occurs while getting the types information.IDfEnumeration getAvailableTypes(boolean includeObsoleteTypes) throws DfException
includeObsoleteTypes
- Determines whether obsolete types should be returned or not.DfException
- If an error occurs while getting the types information.IDfEnumeration getAvailableTypes(java.lang.String baseType) throws DfException
baseType
- The base type.DfException
- If an error occurs while getting the types information.IDfEnumeration getAvailableTypes(java.lang.String baseType, boolean includeObsoleteTypes) throws DfException
baseType
- The base type.includeObsoleteTypes
- Determins whether obsolete types should be returned or not.DfException
- If an error occurs while getting the types information.IDfSearchTypeAssistant getTypeAssistant(java.lang.String typeName) throws DfException
typeName
- The type name, such as dm_document.
null
if the type is not found.DfException
- If an error occurs while getting the type information.IDfSearchTypeAssistant getTypeAssistant(java.lang.String typeName, boolean includeObsoleteTypes) throws DfException
typeName
- The type name, such as dm_document.
includeObsoleteTypes
- Determines whether obsolete types should be returned or not by the type assistant.null
if the type is not found.DfException
- If an error occurs while getting the type information.java.lang.String getDefaultTypeName()
java.lang.String convertMimeToDocbaseFormat(java.lang.String mimeFormat) throws DfException
mimeFormat
- The MIME format value.DfException
- If an error occurs while converting the value.java.lang.String convertDocbaseToMimeFormat(java.lang.String docbaseFormat) throws DfException
docbaseFormat
- The repository format value.DfException
- If an error occurs while converting the value.IDfList getDOSExtensions(java.lang.String mimeFormat) throws DfException
mimeFormat
- The MIME format value.DfException
- If an error occurs while converting the value.Copyright 1994-2023 OpenText Corporation. All rights reserved.