com.ibm.pim.utils
Interface IISIntegration


public interface IISIntegration

This interfaces defines methods for integration with IIS

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List<java.lang.String> exportAttributeCollectionMetadata(java.util.Collection<java.lang.String> attrCollNames)
          This method takes an Collection of String representing the Attribute Collection names as input parameter and exports the metadata(of Attribute Collection) in XML Schema format in a XSD file and uploads the file to the docstore for each Attribute Collection.
 void exportBusinessGlossary(java.util.Collection<java.lang.String> specNames)
          This method takes a Collection of String representing the Spec Names as the input parameter and exports the metadata(spec) description in the Business Glossary format in a XML file and uploads the file to the docstore for each spec.
 java.lang.String getAttributeCollectionMetadata(java.lang.String attrCollName)
          This method returns Metadata information in a String having XML Schema format, for given AttributeCollection name .
 java.lang.String getBusinessGlossary(java.lang.String specName)
          This method returns a Business Glossary XML as String for given Spec name.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

exportBusinessGlossary

void exportBusinessGlossary(java.util.Collection<java.lang.String> specNames)
This method takes a Collection of String representing the Spec Names as the input parameter and exports the metadata(spec) description in the Business Glossary format in a XML file and uploads the file to the docstore for each spec.

Parameters:
specNames - Collection of Spec names
Throws:
PIMInternalException - when internal error occurs
java.lang.IllegalArgumentException - when the Collection of specNames is null

getBusinessGlossary

java.lang.String getBusinessGlossary(java.lang.String specName)
This method returns a Business Glossary XML as String for given Spec name.

Parameters:
specName - Spec name to be exported for Business Glossary
Returns:
String XML content as a string
Throws:
PIMInternalException - when internal error occurs
java.lang.IllegalArgumentException - when the specName is null or an empty string

exportAttributeCollectionMetadata

java.util.List<java.lang.String> exportAttributeCollectionMetadata(java.util.Collection<java.lang.String> attrCollNames)
This method takes an Collection of String representing the Attribute Collection names as input parameter and exports the metadata(of Attribute Collection) in XML Schema format in a XSD file and uploads the file to the docstore for each Attribute Collection.

Parameters:
attrCollNames - Collection of AttributeCollection names
Returns:
List containing the Attribute Collection names which were not exported due to some error.
Throws:
PIMInternalException - when internal error occurs
java.lang.IllegalArgumentException - when the Collection of AttributeCollection Name is null

getAttributeCollectionMetadata

java.lang.String getAttributeCollectionMetadata(java.lang.String attrCollName)
This method returns Metadata information in a String having XML Schema format, for given AttributeCollection name .

Parameters:
attrCollName - Attribute Collection name to be exported for Metadata Information
Returns:
String XML Schema content as a string
Throws:
PIMInternalException - when internal error occurs
java.lang.IllegalArgumentException - when the AttributeCollection name is null or an empty string