Package wt.org.delegate

Class ReplicatedUserForActivationByUserNameMatchDelegate

java.lang.Object
wt.org.delegate.ReplicatedUserForActivationByUserNameMatchDelegate
All Implemented Interfaces:
PrincipalMatchDelegate
public class ReplicatedUserForActivationByUserNameMatchDelegate extends Object implements PrincipalMatchDelegate
Delegate for finding a replicated user on the local system, matching the user that is being created, for the purpose of activating/converting to an active user.

This delegate implementation adheres to the contract elaborated in the PrincipalMatchDelegate interface. This delegate implementation is specifically for finding a replicated user matching a user that is being created, using a pre-determined set of match rules. See the API match(WTPrincipal querySpec) in this class for specifics on the rules applied in this implementation.

For more information about configuring a delegate service for finding replicated users, for activation, see the Windchill Customization Guide.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • match

      public WTPrincipal match(WTPrincipal querySpec) throws WTException
      Finds a matching Replicated user based on values populated in the input principal, which acts as the query specification.

      The input principal must be a WTUser object with the following field populated with a valid value, which will be used for finding a matching Replicated user:
      • UserName
      • Alternate UserNames (Optional)

      Following rules are applied in finding a matching Replicated user:
      • If a UserName is provided, a Replicated user with a matching UserName or Alternate UserNames(if available) will be returned, if found
      • If no match is found, a NULL result will be returned
      • If no UserName can be read from the querySpec or if the querySpec is not a WTUser, a NULL result will be returned

      Exception conditions:
      • AmbiguousPrincipalException - If multiple matches are found
      Refer to the interface for the complete API contract: PrincipalMatchDelegate

      Supported API: true
      Specified by:
      match in interface PrincipalMatchDelegate
      Parameters:
      querySpec -
      Returns:
      Throws:
      WTException