Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure includes basic information about a locked entity. The information represented in this structure is not comprehensive and only includes certain key attributes of a locked deemed to be useful in an acquisition of a lockrepresents the locked state of a Projector entity such as an engagement or a project. A collection of these structures is returned from PwsAcquireProjectorLocks and similar requests when one or more entities being locked were already locked. It is also what is passed back to PwsAcquireProjectorLocks and similar requests when you want to steal the locks. The contents of the data structure identify the existing locks with enough detail that upon attempting to steal the locks, Projector can determine that no locks have been altered or no additional locks have been obtained since the original request. The request to steal the locks will fail if it is determined that the specified LocksToSteal no longer accurately represents the current state.


Format


Panel
titlePwsEntityLockSummary

...

Element

Data Type

Description

Sample Data

EntityIdentity

PwsProjectorLockEntity

This structure uniquely identifies the entity that will be is locked.


EntityLockSummary

PwsEntityLockSummaryItem[1..100]

This structure contains information associated with an entity lock and uniquely identifies the user who is currently holding it.


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
              <com:PwsEntityLockSummary>
                  <com:EntityIdentity>
                     <com:EntityCode>P001468-001</com:EntityCode>
                     <com:EntityUid>1152921504607429941</com:EntityUid>
                     <com:LockType>P</com:LockType>
                  </com:EntityIdentity>
                  <com:EntityLockSummary>
                     <com:PwsEntityLockSummaryItem>
                        <com:LockCount>1</com:LockCount>
                        <com:LockHolderUserIdentity>
                           <com:UserDisplayName>IT Manager</com:UserDisplayName>
                           <com:UserReferenceSystemId>IT Manager</com:UserReferenceSystemId>
                        </com:LockHolderUserIdentity>
                        <com:MostRecentLockAcquisitionTimestamp>2018-10-16T13:59:12.903Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>