com.stellent.cis.client.api.common.administrative
Interface ICISCommonMetadataMap

All Superinterfaces:

ICISObjectInitializable, java.io.Serializable

public interface ICISCommonMetadataMap
extends java.io.Serializable, ICISObjectInitializable

Provides a metadata relationship between disparate repositories.

Nested Class Summary

static interface

ICISCommonMetadataMap.FieldEntry Holds the information used for a field mapping, including the native name and the object class

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Method Summary

ICISCommonContributionMap	_createContributionMap(java.lang.String adapterName, java.lang.String commonType, java.lang.String nativeType)
void	addMapping(java.lang.String commonName, java.lang.String nativeName, java.lang.String adapterName) Sets up a mapping for metadata, the common name supplied will now be treated as synonymous with the native name supplied for the specified adapter.
void	addMapping(java.lang.String commonName, java.lang.String objectClass, java.lang.String nativeName, java.lang.String adapterName) Sets up a mapping for metadata, the common name supplied will now be treated as synonymous with the native name supplied for the specified adapter.
java.util.Collection	getAdapterNames()
java.util.Collection	getCommonDocumentTypes()
java.util.Collection	getCommonNames()
java.util.Collection	getCommonNames(java.lang.String adapterName)
ICISCommonContributionMap	getContributionMap(java.lang.String adapterName, java.lang.String documentType)
java.lang.String	getDocumentType(java.lang.String adapter, java.lang.String commonName)
java.util.Collection	getDocumentTypes(java.lang.String adapter)
java.util.Map	getMapByAdapter(java.lang.String adapterName)
java.lang.String	getNativeName(java.lang.String commonName, java.lang.String adapterName)
java.lang.String	getObjectClassName(java.lang.String commonName, java.lang.String adapterName)

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Method Detail

_createContributionMap

ICISCommonContributionMap _createContributionMap(java.lang.String adapterName,
                                                 java.lang.String commonType,
                                                 java.lang.String nativeType)

Parameters:

adapterName - the name of the adapter

commonType - the document type or null for any type

nativeType - the native document type this corresponds to in the target server

Returns:

create a contribution map an associate it with this metadata map

addMapping

void addMapping(java.lang.String commonName,
                java.lang.String nativeName,
                java.lang.String adapterName)

Sets up a mapping for metadata, the common name supplied will now be treated as synonymous with the native name supplied for the specified adapter.

Parameters:

commonName - The common name to use.

nativeName - The native name on specified adapter.

adapterName - The adapter to provide mapping for.

addMapping

void addMapping(java.lang.String commonName,
                java.lang.String objectClass,
                java.lang.String nativeName,
                java.lang.String adapterName)

Sets up a mapping for metadata, the common name supplied will now be treated as synonymous with the native name supplied for the specified adapter.

Parameters:

commonName - The common name to use.

objectClass - the objectclass to which this property maps

nativeName - The native name on specified adapter.

adapterName - The adapter to provide mapping for.

getMapByAdapter

java.util.Map getMapByAdapter(java.lang.String adapterName)

Parameters:

adapterName - The adapter name to return map for.

Returns:

A map of common names to ICISCommonMetadataMap.FieldEntry for the specified adapter.

getContributionMap

ICISCommonContributionMap getContributionMap(java.lang.String adapterName,
                                             java.lang.String documentType)

Parameters:

adapterName - the adapter name

Returns:

the contribution map associated with the adapter

getDocumentTypes

java.util.Collection getDocumentTypes(java.lang.String adapter)

Parameters:

adapter - the adapter to query

Returns:

a list of strings representing all the common document types for this adapter

getDocumentType

java.lang.String getDocumentType(java.lang.String adapter,
                                 java.lang.String commonName)

Parameters:

adapter - The adapter to find native value for.

commonName - The common name associated with native name.

Returns:

The native type for the specified adapter, commonName.

getCommonDocumentTypes

java.util.Collection getCommonDocumentTypes()

Returns:

a list of strings containing only the common document types defined in all adapters

getObjectClassName

java.lang.String getObjectClassName(java.lang.String commonName,
                                    java.lang.String adapterName)

Parameters:

commonName - The common name to retrieve content class for.

adapterName - The adapter name to use.

Returns:

The string that represents the native class type.

getNativeName

java.lang.String getNativeName(java.lang.String commonName,
                               java.lang.String adapterName)

Parameters:

commonName - The common name to get mapping for.

adapterName - The adapter name.

Returns:

The native name for the supplied adapter.

getCommonNames

java.util.Collection getCommonNames(java.lang.String adapterName)

Returns:

A list of available common names that are currently defined by adapter name.

getCommonNames

java.util.Collection getCommonNames()

Returns:

A list of available common names that are currently defined.

getAdapterNames

java.util.Collection getAdapterNames()

Returns:

a list of the names of adapters that are currently mapped