com.ibm.pim.utils
Interface ExportRequisiteList


public interface ExportRequisiteList

Interface representing an object that holds requisite objects for objects in an export list.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.Collection<java.lang.Object> getRequisiteObjects(ExportList.Type type)
          Fetches all the requisite objects of a given type.
 java.util.Collection<java.lang.Object> getRequisiteObjects(ExportList.Type exportObjectType, java.lang.Object object, ExportList.Type requisiteObjectType)
          Fetches all the objects of the given type which the object in the export list requires for successful creation.
 java.util.Set<ExportList.Type> getRequisiteTypes()
          Fetches all the requisite types for objects in the ExportList corresponding to this requisite list.
 java.util.Set<ExportList.Type> getRequisiteTypes(ExportList.Type type, java.lang.Object object)
          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 ExportList corresponding to this requisite list.

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

getRequisiteObjects

java.util.Collection<java.lang.Object> getRequisiteObjects(ExportList.Type type)
Fetches all the requisite objects of a given type.

Parameters:
type - The PIM object type for environment export and import
Returns:
A Collection of PIM objects.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - If user does not have permission to access the dependent objects
java.lang.IllegalArgumentException - If type is null

getRequisiteTypes

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

Parameters:
type - The type of the object for which requisite object types are requested.
object - The PIM object for which requisite object types are requested.
Returns:
An Collection of object types.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If type or object is null or if there is any mismatch between the object type and PIM object or if the object is not present in the ExportList
java.lang.IllegalStateException - If the object has not been persisted

getRequisiteObjects

java.util.Collection<java.lang.Object> getRequisiteObjects(ExportList.Type exportObjectType,
                                                           java.lang.Object object,
                                                           ExportList.Type requisiteObjectType)
Fetches all the objects of the given type which the object in the export list requires for successful creation.

Parameters:
exportObjectType - The type of the PIM object that is present in the export list.
object - The PIM object that is present in the export list.
requisiteObjectType - The type of the objects required by the object in the export list
Returns:
A Collection of PIM objects of the type 'requisiteObjectType'
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - If user does not have permission to access the dependent objects
java.lang.IllegalArgumentException - If any of the arguments is null or if there is any mismatch between the exportObjectType and PIM object or if the object is not present in the ExportList.
java.lang.IllegalStateException - If the object has not been persisted