PwsEntityLockSummary

Owned by Bettina Borces
Last updated: Nov 09, 2018 by Luke Wright
2 min read

Overview


This structure represents 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


PwsEntityLockSummary

Elements


Element

Data Type

Description

Sample Data

EntityIdentity

PwsProjectorLockEntity

This structure uniquely identifies the entity that 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)


Example 01 
              <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>