com.ibm.pim.utils
Interface ImportRequisiteList


public interface ImportRequisiteList

Interface representing an object that holds names of requisite objects for objects in an import list. The names are obtained from the object representations in the zip file. The system does not perform a check on whether the object is present in the company in which this operation is performed. If a PIM object depends on any object which is not part of the ImportList, it is present in the ImportRequisiteList.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List<java.lang.String> getRequisiteObjects(ExportList.Type type)
          Fetches all the requisite objects of a given type.
 java.util.List<java.lang.String> getRequisiteObjectsForHierarchyMap(java.lang.String sourceHierarchyName, java.lang.String destinationHierarchyName, ExportList.Type type)
          Fetches all the objects of the given type which the object in the import list requires for successful creation.
 java.util.List<java.lang.String> getRequisiteObjectsForObjectByType(ExportList.Type importObjectType, java.lang.String objectName, ExportList.Type requisiteObjectType)
          Fetches all the objects of the given type which the object in the import list requires for successful creation.
 java.util.Set<ExportList.Type> getRequisiteTypes()
          Fetches all the requisite types for objects in the ImportList corresponding to this requisite list.
 java.util.Set<ExportList.Type> getRequisiteTypesForHierarchyMap(java.lang.String sourceHierarchyName, java.lang.String destinationHierarchyName)
          Fetches the types of requisite objects for the given HierarchyMap.
 java.util.Set<ExportList.Type> getRequisiteTypesForObject(ExportList.Type type, java.lang.String objectName)
          Fetches the types of requisite objects for the given object.
 

Field Detail

copyright

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

getRequisiteTypes

java.util.Set<ExportList.Type> getRequisiteTypes()
Fetches all the requisite types for objects in the ImportList corresponding to this requisite list.

Returns:
A Set of object types.
Throws:
PIMInternalException - If an internal error occurs.

getRequisiteObjects

java.util.List<java.lang.String> getRequisiteObjects(ExportList.Type type)
Fetches all the requisite objects of a given type. The objects in this import list require these objects for creation.

Parameters:
type - The PIM object type.
Returns:
A List of object names.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If type is null

getRequisiteTypesForObject

java.util.Set<ExportList.Type> getRequisiteTypesForObject(ExportList.Type type,
                                                          java.lang.String objectName)
Fetches the types of requisite objects for the given object.

Parameters:
type - The type of the object for which requisite object types are requested.
objectName - The name of the PIM object for which requisite object types are requested.
Returns:
A Set of object types.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If type or objectName is null or the objectName is an empty string or the object is not present in the ImportList

getRequisiteObjectsForObjectByType

java.util.List<java.lang.String> getRequisiteObjectsForObjectByType(ExportList.Type importObjectType,
                                                                    java.lang.String objectName,
                                                                    ExportList.Type requisiteObjectType)
Fetches all the objects of the given type which the object in the import list requires for successful creation.

Parameters:
importObjectType - The type of the PIM object that is present in the export list.
objectName - The name of the PIM object that is present in the import list.
requisiteObjectType - The type of the objects required by the object in the import list
Returns:
A List of object names of the type 'requisiteObjectType'
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If importObjectType or objectName is null or the objectName is an empty string or requisiteObjectType is null or the object is not present in the ImportList

getRequisiteTypesForHierarchyMap

java.util.Set<ExportList.Type> getRequisiteTypesForHierarchyMap(java.lang.String sourceHierarchyName,
                                                                java.lang.String destinationHierarchyName)
Fetches the types of requisite objects for the given HierarchyMap.

Parameters:
sourceHierarchyName - The name of the source hierarchy.
destinationHierarchyName - The name of the destination hierarchy.
Returns:
A Set of object types.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If arguments are null or an empty string or the HierarchyMap is not present in the ImportList

getRequisiteObjectsForHierarchyMap

java.util.List<java.lang.String> getRequisiteObjectsForHierarchyMap(java.lang.String sourceHierarchyName,
                                                                    java.lang.String destinationHierarchyName,
                                                                    ExportList.Type type)
Fetches all the objects of the given type which the object in the import list requires for successful creation.

Parameters:
sourceHierarchyName - The name of the source hierarchy.
destinationHierarchyName - The name of the destination hierarchy.
type - The type of the objects required by the HierarchyMap in the import list
Returns:
A List of object names of the type 'type'
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If arguments are null or an empty string or the HierarchyMap is not present in the ImportList.