com.appiancorp.suiteapi.ix

Class ImportResults

java.lang.Object

com.appiancorp.suiteapi.ix.ImportResults

public class ImportResults
extends java.lang.Object

Detailed results from importing or inspecting a package with objects. When inspecting, this reports which objects will be created, or updated, and which objects will fail to be imported due to a missing precedent. When importing, this is a report of exactly which objects were created, updated, or failed to import.

Constructor Summary

Constructors

Constructor and Description
ImportResults(java.lang.Long logId, java.util.List<ImportObject> createdObjects, java.util.List<ImportObject> updatedObjects, java.util.List<ImportObject> failedObjects) Deprecated. This constructor will be removed in a future release. Use ImportResults(Long, List, List, List, List, List) instead
ImportResults(java.lang.Long logId, java.util.List<ImportObject> createdObjects, java.util.List<ImportObject> updatedObjects, java.util.List<ImportObject> failedObjects, java.util.List<ImportObject> notChangedObjects, java.util.List<ImportObject> conflictedObjects)

Method Summary

Modifier and Type	Method and Description
java.util.List<ImportObject>	getConflictedObjects() A conflict means that changes were made in both the source (package) and target systems.
java.util.List<ImportObject>	getCreatedObjects() On import, returns the list of objects that were created.
java.util.List<ImportObject>	getFailedObjects() On import, returns the list of objects that have failed to import, along with the list of objects already in the target system which are now in a failure state as a result of this import.
java.lang.Long	getLogDocumentId() Retrieves the document ID of the detailed import log file.
java.util.List<ImportObject>	getNotChangedObjects() On import, returns the list of objects that were skipped because no changes were detected.
java.util.List<ImportObject>	getUpdatedObjects() On import, returns the list of objects that were updated.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportResults

@Deprecated
public ImportResults(java.lang.Long logId,
                                 java.util.List<ImportObject> createdObjects,
                                 java.util.List<ImportObject> updatedObjects,
                                 java.util.List<ImportObject> failedObjects)

Deprecated. This constructor will be removed in a future release. Use ImportResults(Long, List, List, List, List, List) instead

ImportResults

public ImportResults(java.lang.Long logId,
                     java.util.List<ImportObject> createdObjects,
                     java.util.List<ImportObject> updatedObjects,
                     java.util.List<ImportObject> failedObjects,
                     java.util.List<ImportObject> notChangedObjects,
                     java.util.List<ImportObject> conflictedObjects)

Method Detail

getLogDocumentId

public java.lang.Long getLogDocumentId()

Retrieves the document ID of the detailed import log file.

Returns:

the document ID of the detailed import log file.

getCreatedObjects

public java.util.List<ImportObject> getCreatedObjects()

On import, returns the list of objects that were created. On inspect, returns the list of objects that will be created. This method internally uses Collections.unmodifiableList(List) in order to return an unmodifiable list.

Returns:

the list of objects that were or would be created.

getUpdatedObjects

public java.util.List<ImportObject> getUpdatedObjects()

On import, returns the list of objects that were updated. On inspect, returns the list of objects that will be updated. This method internally uses Collections.unmodifiableList(List) in order to return an unmodifiable list.

Returns:

the list of objects that were or would be updated.

getNotChangedObjects

public java.util.List<ImportObject> getNotChangedObjects()

On import, returns the list of objects that were skipped because no changes were detected. On inspect, returns the list of objects that will be skipped on import because no changes have been detected. Import can be forced by including an import customization file with the relevant setting. This method internally uses Collections.unmodifiableList(List) in order to return an unmodifiable list.

Returns:

the list of objects that were not changed on import or would not be changed on inspect. Not changed objects are the ones in the import package which are identical to an object already on the target system.

getConflictedObjects

public java.util.List<ImportObject> getConflictedObjects()

A conflict means that changes were made in both the source (package) and target systems. On import, returns the list of objects where conflicts were detected and changes in the target system were overwritten by the definition in the import package. On inspect, returns the list of objects where conflicts were detected. If imported, these objects will overwrite any changes in the target system. This method internally uses Collections.unmodifiableList(List) in order to return an unmodifiable list.

Returns:

the subset of getUpdatedObjects() where the object in the import package overwrote or would have overwritten a change on the target system.

getFailedObjects

public java.util.List<ImportObject> getFailedObjects()

On import, returns the list of objects that have failed to import, along with the list of objects already in the target system which are now in a failure state as a result of this import. On inspect, returns the list of objects that will fail to import, along with the list of objects already in the target system which would be in a failure state as a result of this import. This method internally uses Collections.unmodifiableList(List) in order to return an unmodifiable list.

Returns:

the list of objects that have failed or will fail to import.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object