Package wt.change2

Interface ChangeLockService

@RemoteInterface public interface ChangeLockService
This is the interface for the changeApplicationLock attribute on the VersionableChangeItem.
Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    WTHashSet
    lockRelatedMaterials(WTCollection changeItems, long... lockLevel)
    This method will set a change application lock on a WTCollection of VersionableChangeItems.
    WTHashSet
    unlockRelatedMaterials(WTCollection changeItems, long... lockLevel)
    This method will remove a change application lock from a WTCollection of VersionableChangeItems.

  • Method Details

    • lockRelatedMaterials

      WTHashSet lockRelatedMaterials(WTCollection changeItems, long... lockLevel) throws WTException
      This method will set a change application lock on a WTCollection of VersionableChangeItems. Any duplicates will be removed. If a WTChangeOrder is provided, the API will also automatically query for any related WTChangeActivity2 objects and will set the lock on those as well. The returned set is a new WTHashSet of all of the objects that were updated as part of this call. As a warning, the changeItems input into this API will become stale after it is invoked, and it is advised to use the returned WTHashSet instead.

      Supported API: true
      Parameters:
      changeItems - - Collection of VersionableChangeItems which will become stale after the call
      lockLevel - - Locks to be set. Refer to ChangeApplicationLock for supported locks for change.
      Throws:
      WTException

    • unlockRelatedMaterials

      WTHashSet unlockRelatedMaterials(WTCollection changeItems, long... lockLevel) throws WTException
      This method will remove a change application lock from a WTCollection of VersionableChangeItems. Any duplicates will be removed. If a WTChangeOrder is provided, the API will also automatically query for any related WTChangeActivity2 objects and will remove the lock from those as well. The returned set is a new WTHashSet of all of the objects that were updated as part of this call. As a warning, the changeItems input into this API will become stale after it is invoked, and it is advised to use the returned WTHashSet instead.

      Supported API: true
      Parameters:
      changeItems - - Collection of VersionableChangeItems which will become stale after the call
      lockLevel - - Locks to be reset.Refer to ChangeApplicationLock for supported locks for change.
      Throws:
      WTException