com.ibm.commerce.member.facade.server.commands

Class FetchPersonCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.TargetableCommandImpl
      • com.ibm.websphere.command.CacheableCommandImpl
        • com.ibm.commerce.member.facade.server.commands.FetchPersonCmdImpl
  • All Implemented Interfaces:
    FetchPersonCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

    public class FetchPersonCmdImpl
extends com.ibm.websphere.command.CacheableCommandImpl
implements FetchPersonCmd
    Fetches persons based on the search criteria specified in the GetType. The following search criteria are supported:
  • {self=true;_wcf.ap=$accessProfile$}/Person - finds the person currently executing the request
  • {_wcf.ap=$accessProfile$}/Person[PersonIdentifier[(UniqueID='$personId$')]] - finds a person based on the UniqueID
  • {_wcf.ap=$accessProfile$}/Person[PersonIdentifier[(DistinguishedName='$distinguishedName$')]] - finds a person based on the distinguished name
  • {_wcf.ap=$accessProfile$}/Person[Credential[LogonID='$logonID$']] - finds a person based on the logon ID

    Returns a list of UserDataBean representing the Persons found.
See Also:
Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.

      • Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

        LOCAL

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID

    • Constructor Summary

      Constructors 
      Constructor and Description
      FetchPersonCmdImpl()
      Creates an instance of the fetch Person command.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.List getPersons()
      Returns a list of UserDataBean representing the Persons found based on the GetType search criteria.
      ShowType getShow()
      Returns the show verb response that represents the results of the fetch operation.
      boolean isReadyToCallExecute()
      Checks if the command is ready to execute.
      void performExecute()
      Fetches persons based on the search criteria specified in the GetType.
      void reset()
      Resets the instance variables so the command can be reused.
      void setGet(GetType getVerb)
      Sets the get expression for the fetch operation.

      • Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

        execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

      • Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

        getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.websphere.command.Command

        execute

      • Methods inherited from interface com.ibm.websphere.command.TargetableCommand

        getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • FetchPersonCmdImpl

        public FetchPersonCmdImpl()
        Creates an instance of the fetch Person command.

    • Method Detail

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Checks if the command is ready to execute.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Specified by:
        isReadyToCallExecute in class com.ibm.websphere.command.TargetableCommandImpl
        Returns:
        true if the get verb is not null; false otherwise
        See Also:
        Command.isReadyToCallExecute()

      • reset

        public void reset()
        Resets the instance variables so the command can be reused.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class com.ibm.websphere.command.CacheableCommandImpl
        See Also:
        Command.reset()

      • performExecute

        public void performExecute()
                    throws java.lang.Exception
        Fetches persons based on the search criteria specified in the GetType. The following search criteria are supported:
      • {self=true;_wcf.ap=$accessProfile$}/Person - finds the person currently executing the request
      • {_wcf.ap=$accessProfile$}/Person[PersonIdentifier[(UniqueID='$personId$')]] - finds a person based on the UniqueID
      • {_wcf.ap=$accessProfile$}/Person[PersonIdentifier[(DistinguishedName='$distinguishedName$')]] - finds a person based on the distinguished name
      • {_wcf.ap=$accessProfile$}/Person[Credential[LogonID='$logonID$']] - finds a person based on the logon ID
Specified by:
performExecute in interface com.ibm.websphere.command.TargetableCommand
Specified by:
performExecute in class com.ibm.websphere.command.TargetableCommandImpl
Throws:
java.lang.Exception
See Also:
TargetableCommand.performExecute()