adTempus API
ArcanaDevelopment.adTempus.Client Namespace / ADTIndependentObject Class / ReplaceObjectReferences Method
List of references to fetch. Null to fetch all references.
If True, the referencing objects are returned in the results. If False, only the OIDs of the referencing objects are returned.
Reserved for future use. Set to 0.
The OIDs of the objects to make the replacement in. See Remarks.
The object to replace the reference with, or a null reference (Nothing in Visual Basic) to remove the reference.
If true, adTempus attempts to save all modified objects. If false, the objects are returned but are not saved.
Optional information to record in the audit log


In This Topic
    ReplaceObjectReferences Method
    In This Topic
    Replaces references to this object.
    Syntax

    Parameters

    referencesToFetch
    List of references to fetch. Null to fetch all references.
    fetchObjects
    If True, the referencing objects are returned in the results. If False, only the OIDs of the referencing objects are returned.
    options
    Reserved for future use. Set to 0.
    replaceInObjects
    The OIDs of the objects to make the replacement in. See Remarks.
    replacementObject
    The object to replace the reference with, or a null reference (Nothing in Visual Basic) to remove the reference.
    saveChanges
    If true, adTempus attempts to save all modified objects. If false, the objects are returned but are not saved.
    changeLogParms
    Optional information to record in the audit log

    Return Value

    True if the operation was completed successfully, False if errors occurred.
    Remarks

    To replace all references to the object in all referencing objects, call with referencesToFetch and replaceInObjects both set to a null reference (Nothing in Visual Basic). If you only want to make the replacement in selected objects, call GetObjectReferences first to get a list of all referencing objects. You can then filter the results and pass the filtered results in replaceInObjects.

    If the replacementObject is a null reference (Nothing in Visual Basic), the reference will be removed, which may require deleting objects. For example, if you remove a reference to a script in a ScriptCondition, the ScriptCondition is no longer valid and will be removed from the job or step that it belongs to.

    Optional information to record in the audit log
    See Also