Package de.elo.ix.client

Class FindUserInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.FindUserInfo
All Implemented Interfaces:
Serializable
public class FindUserInfo extends ValueClass
This class describes the search criteria for IXServicePortIF.findFirstUsers(de.elo.ix.client.ClientInfo, de.elo.ix.client.FindUserInfo, int). The wildcards defined by SessionOptionsC.DB_WILDCARDS can be used for name, desc, property, and ldapProperty. Members name, desc, property, and ldapProperty are combined by OR. Other members are combinded by AND.
Since:
9.00.050.001
See Also:

  • Field Details

    • name

      protected String name
      Find by user name. Search over UserInfo.name.

    • desc

      protected String desc
      Find by user description. Search over UserInfo.desc.

    • property

      protected KeyValue property
      Find by an user property. Search over all UserInfo.userProps. The key element in property is the index in the array UserInfo.userProps.
      Example: 
        
 FindUserInfo findInfo = new FindUserInfo();
 KeyValue property = new KeyValue();
 property.setKey(Integer.toString(UserInfoC.PROP_NAME_EMAIL));
 property.setValue("maria.fritz@alpha.com");

    • ldapProperty

      protected KeyValue ldapProperty
      Find by a LDAP property. Search over all UserInfo.ldapProperties. The key element in property is the key in the map UserInfo.ldapProperties.

    • onlyUsers

      protected boolean onlyUsers

      Search for users only.

      If this member is set to true, flags provided by checkoutUsersZ are ignored.

    • onlyGroups

      protected boolean onlyGroups

      Search for groups only.

      If this member is set to true, flags provided by checkoutUsersZ are ignored.

    • returnUserInfoMap

      protected boolean returnUserInfoMap
      Return entire information about each user. If true, UserInfo objects are returned in FindResult.userInfos. If false, UserName objects are returned in FindResult.userNames. Additionally, FindResult#sortedResult returns a sorted list of either UserInfo or UserName objects.
      See Also:

    • userIds

      protected String[] userIds
      User IDs related to checkoutUsersZ.
      Since:
      10.17.010.004

    • checkoutUsersZ

      protected CheckoutUsersZ checkoutUsersZ
      Filter users as in IXServicePortIF.checkoutUsers(ClientInfo, String[], CheckoutUsersZ, LockZ).
      Since:
      10.17.010.004

    • hasFlags

      protected int hasFlags
      Select only users that have all of this UserInfo.flags set. A value of 0 is ignored. The selected users are found by testing (UserInfo#flags & hasFlags) == hasFlags.
      Since:
      10.17.010.005

    • hasNotFlags

      protected int hasNotFlags
      Select only users that have non this UserInfo.flags set. The selected users are found by testing (UserInfo#flags & hasNotFlags) == 0.
      Since:
      10.17.010.005

    • hasFlags2

      protected int hasFlags2
      Select only users that have all of this UserInfo.flags2 set. A value of 0 is ignored. The selected users are found by testing (UserInfo#flags2 & hasFlags2) == hasFlags2.
      Since:
      10.17.010.005

    • hasNotFlags2

      protected int hasNotFlags2
      Select only users that have none this UserInfo.flags2 set. The selected users are found by testing (UserInfo#flags2 & hasNotFlags2) == 0.
      Since:
      10.17.010.005

    • sortOrder

      protected int sortOrder
      Specify how the results should be ordered. Valid values are SortOrderC.USERNAME and SortOrderC.IUSERNAME. Sorted results are returned in FindResult#sortedResult.
      Since:
      11.00.000.028
      See Also:

    • findResultAccessMode

      protected FindResultAccessMode findResultAccessMode
      Describes how the client application will access the results.
      Since:
      11.00.000.033

    • workspaceInfo

      protected String workspaceInfo
      Workspace related data.
      Since:
      21.02.000.017

  • Constructor Details

    • FindUserInfo

      public FindUserInfo()

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getDesc

      public String getDesc()

    • setDesc

      public void setDesc(String desc)

    • getProperty

      public KeyValue getProperty()

    • setProperty

      public void setProperty(KeyValue property)

    • getLdapProperty

      public KeyValue getLdapProperty()

    • setLdapProperty

      public void setLdapProperty(KeyValue ldapProperty)

    • isOnlyUsers

      public boolean isOnlyUsers()

    • setOnlyUsers

      public void setOnlyUsers(boolean onlyUsers)

    • isOnlyGroups

      public boolean isOnlyGroups()

    • setOnlyGroups

      public void setOnlyGroups(boolean onlyGroups)

    • isReturnUserInfoMap

      public boolean isReturnUserInfoMap()

    • setReturnUserInfoMap

      public void setReturnUserInfoMap(boolean returnUserInfoMap)

    • getCheckoutUsersZ

      public CheckoutUsersZ getCheckoutUsersZ()

    • setCheckoutUsersZ

      public void setCheckoutUsersZ(CheckoutUsersZ checkoutUsersZ)

    • getUserIds

      public String[] getUserIds()

    • setUserIds

      public void setUserIds(String[] userIds)

    • getHasFlags

      public int getHasFlags()

    • getHasNotFlags

      public int getHasNotFlags()

    • getHasFlags2

      public int getHasFlags2()

    • getHasNotFlags2

      public int getHasNotFlags2()

    • setHasFlags

      public void setHasFlags(int hasFlags)

    • setHasNotFlags

      public void setHasNotFlags(int hasNotFlags)

    • setHasFlags2

      public void setHasFlags2(int hasFlags2)

    • setHasNotFlags2

      public void setHasNotFlags2(int hasNotFlags2)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getSortOrder

      public int getSortOrder()

    • setSortOrder

      public void setSortOrder(int sortOrder)

    • getFindResultAccessMode

      public FindResultAccessMode getFindResultAccessMode()

    • setFindResultAccessMode

      public void setFindResultAccessMode(FindResultAccessMode findResultAccessMode)

    • getWorkspaceInfo

      public String getWorkspaceInfo()

    • setWorkspaceInfo

      public void setWorkspaceInfo(String workspaceInfo)