|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExportList
An interface representing an object that holds the list of objects to be exported from a company. For each object, the action mode in which the object has to be exported is also stored.
Nested Class Summary | |
---|---|
static class |
ExportList.ActionMode
Enumeration of action modes for environment export and import tool. |
static class |
ExportList.Type
Enumeration of object types for use by environment export and import tool. |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addAllContents(ExportList.Type type)
Adds contents of all objects of type specified by parameter 'type' to the export list. |
void |
addAllObjects(ExportList.Type type,
ExportList.ActionMode actionMode)
Adds all objects of type specified by parameter 'type' in the action mode specified by the parameter 'actionMode' to this export list. |
void |
addAllRequisites()
Adds all the objects on which the objects in this list are dependent on, to the list. |
void |
addContent(ExportList.Type type,
java.lang.Object object)
Adds contents of objects to the ExportList |
void |
addObject(ExportList.Type type,
java.lang.Object object,
ExportList.ActionMode actionMode)
Adds the objects of type specified by parameter 'type' in the action mode specified by the parameter 'actionMode' to the ExportList. |
boolean |
areAllRequisitesMet()
Determines whether any object dependency is present for this export list. |
java.util.Set<ExportList.Type> |
getObjectTypes()
Returns the type of objects which were added to this ExportList. |
ExportRequisiteList |
getRequisites()
Returns the objects that the objects in this export list are dependent on. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void addAllObjects(ExportList.Type type, ExportList.ActionMode actionMode)
type
- The PIM object typeactionMode
- The action mode in which the object has to be exported.
PIMInternalException
- if an internal error occurs
java.lang.IllegalArgumentException
- If type or actionMode is null or if actionMode is not
supported by the specified type.Supported ActionModes for Type
void addObject(ExportList.Type type, java.lang.Object object, ExportList.ActionMode actionMode)
type
- The PIM object typeobject
- The PIM objectactionMode
- The action mode to be used for export of this object.
PIMInternalException
- if an internal error occurs
java.lang.IllegalArgumentException
- If type is null or object is null or actionMode is null or if
there is any mismatch between the object type and PIM object
java.lang.UnsupportedOperationException
- If type is ExportList.Type.ALERT
or
ExportList.Type.QUEUE
. Use
addAllObjects(com.ibm.pim.utils.ExportList.Type, com.ibm.pim.utils.ExportList.ActionMode)
to export these objects.
java.lang.IllegalStateException
- If the object has not been persisted
void addContent(ExportList.Type type, java.lang.Object object)
type
- The PIM object typeobject
- The PIM object
PIMInternalException
- if an internal error occurs
java.lang.IllegalArgumentException
- If type is null or object is null or if there is any mismatch
between the object type and PIM object
java.lang.IllegalStateException
- If the object has not been persisted
Type | PIM Object | |||||||||
ExportList.Type.CATALOG_CONTENT |
Catalog |
|||||||||
ExportList.Type.HIERARCHY_CONTENT |
Hierarchy |
|||||||||
ExportList.Type.ORGANIZATION_HIERARCHY_CONTENT |
OrganizationHierarchy |
|||||||||
ExportList.Type.USER_DEFINED_LOG_CONTENT |
UserDefinedLog |
|||||||||
ExportList.Type.LOOKUP_TABLE_CONTENT |
LookupTable |
Type | ||||||||||
ExportList.Type.CATALOG_CONTENT |
||||||||||
ExportList.Type.HIERARCHY_CONTENT |
||||||||||
ExportList.Type.ORGANIZATION_HIERARCHY_CONTENT |
||||||||||
ExportList.Type.USER_DEFINED_LOG_CONTENT |
||||||||||
ExportList.Type.LOOKUP_TABLE_CONTENT |
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |