Class ObjectImportParameters

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Options to control how a particular object is imported.

[Serializable]
[DataContract]
public class ObjectImportParameters

Inheritance

object

ObjectImportParameters

Constructors

ObjectImportParameters()

Creates a new ObjectImportParameters with default values.

public ObjectImportParameters()

ObjectImportParameters(ImportObjectHeader)

Initializes a new ObjectImportParameters with the settings from an ImportObjectHeader returned by a ArcanaDevelopment.adTempus.Client.ImportExportFacility.ParseImportData operation.

public ObjectImportParameters(ImportObjectHeader header)

Parameters

Name	Type	Description
header	ImportObjectHeader	The source information. See Remarks.

Remarks

The ObjectImportParameters values are set from the header as follows:

Value Source OID Set to the OID from the header. MapToOID Set to the DuplicateObjectOID from the header, if present. ImportAction If the ObjectState is New, DuplicateKeyOlder, or ExistingOlder, the ImportAction is set to Import. Otherwise it is set to Skip. That is, but default any objects that are newer than the import source will be skipped.

Fields

GenerateNewCopy

Specifies that a new copy of the object should be created, instead of updating the existing copy.

[DataMember]
public bool GenerateNewCopy

Field Value

bool

Remarks

If GenerateNewCopy is True, the import will ignore the existing version of the object (if any) and create a new copy, with a new OID, of the object being imported (and of all of the objects it owns). Any objects in the source that reference the object will be changed to reference the new copy.

ImportAction

Indicates whether or not to import the object. Defaults to Import.

[DataMember]
public ObjectImportAction ImportAction

Field Value

ObjectImportAction

Remarks

The object may be imported even if the ImportAction is set to Skip. See Skip for more information.

MapToOID

The OID this object will be mapped to.

[DataMember]
public OID MapToOID

Field Value

OID

Remarks

If MapToOID is set, the object with the specified OID is updated instead of the original target object, and all references in the import source to the original object are replaced with references to MapToOID instead.

For example, the ObjectImportParameters for the job with OID A have the MapToOID set to OID B. The existing job with OID B will be updated using the data in the source, and all objects in the source that reference OID A will be changed to reference OID B instead.

This value should be set if the ObjectState is one of the Duplicate values, so that the object with the duplicate key is updated instead of creating a new object with a duplicate key.

If you use the ObjectImportParameters(ImportObjectHeader) constructor, the MapToOID value is automatically set from the DuplicateObjectOID if appropriate.

OID

The OID of the object to set actions for.

[DataMember]
public OID OID

Field Value

OID