java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.FindUserInfo

All Implemented Interfaces:: java.io.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:: Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected CheckoutUsersZ`	`checkoutUsersZ`	Filter users as in `IXServicePortIF.checkoutUsers(ClientInfo, String[], CheckoutUsersZ, LockZ)`.
`protected java.lang.String`	`desc`	Find by user description.
`protected FindResultAccessMode`	`findResultAccessMode`	Describes how the client application will access the results.
`protected int`	`hasFlags`	Select only users that have all of this `UserInfo.flags` set.
`protected int`	`hasFlags2`	Select only users that have all of this `UserInfo.flags2` set.
`protected int`	`hasNotFlags`	Select only users that have non this `UserInfo.flags` set.
`protected int`	`hasNotFlags2`	Select only users that have none this `UserInfo.flags2` set.
`protected KeyValue`	`ldapProperty`	Find by a LDAP property.
`protected java.lang.String`	`name`	Find by user name.
`protected boolean`	`onlyGroups`	Search for groups only.
`protected boolean`	`onlyUsers`	Search for users only.
`protected KeyValue`	`property`	Find by an user property.
`protected boolean`	`returnUserInfoMap`	Return entire information about each user.
`protected int`	`sortOrder`	Specify how the results should be ordered.
`protected java.lang.String[]`	`userIds`	User IDs related to `checkoutUsersZ`.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor Description

FindUserInfo()

Method Summary

Modifier and Type	Method	Description
`CheckoutUsersZ`	`getCheckoutUsersZ()`
`java.lang.String`	`getDesc()`
`FindResultAccessMode`	`getFindResultAccessMode()`
`int`	`getHasFlags()`
`int`	`getHasFlags2()`
`int`	`getHasNotFlags()`
`int`	`getHasNotFlags2()`
`KeyValue`	`getLdapProperty()`
`java.lang.String`	`getName()`
`KeyValue`	`getProperty()`
`int`	`getSortOrder()`
`java.lang.String[]`	`getUserIds()`
`boolean`	`isOnlyGroups()`
`boolean`	`isOnlyUsers()`
`boolean`	`isReturnUserInfoMap()`
`void`	`setCheckoutUsersZ(CheckoutUsersZ checkoutUsersZ)`
`void`	`setDesc(java.lang.String desc)`
`void`	`setFindResultAccessMode(FindResultAccessMode findResultAccessMode)`
`void`	`setHasFlags(int hasFlags)`
`void`	`setHasFlags2(int hasFlags2)`
`void`	`setHasNotFlags(int hasNotFlags)`
`void`	`setHasNotFlags2(int hasNotFlags2)`
`void`	`setLdapProperty(KeyValue ldapProperty)`
`void`	`setName(java.lang.String name)`
`void`	`setOnlyGroups(boolean onlyGroups)`
`void`	`setOnlyUsers(boolean onlyUsers)`
`void`	`setProperty(KeyValue property)`
`void`	`setReturnUserInfoMap(boolean returnUserInfoMap)`
`void`	`setSortOrder(int sortOrder)`
`void`	`setUserIds(java.lang.String[] userIds)`
`java.lang.String`	`toString()`

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- name
  
  protected java.lang.String name
  
  Find by user name. Search over UserInfo.name.
- desc
  
  protected java.lang.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:
  
  sortOrder
- userIds
  
  protected java.lang.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:
  
  returnUserInfoMap
- findResultAccessMode
  
  protected FindResultAccessMode findResultAccessMode
  
  Describes how the client application will access the results.
  
  Since:
  
  11.00.000.033
Constructor Details
- FindUserInfo
  
  public FindUserInfo()
Method Details
- getName
  
  public java.lang.String getName()
- setName
  
  public void setName(java.lang.String name)
- getDesc
  
  public java.lang.String getDesc()
- setDesc
  
  public void setDesc(java.lang.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 java.lang.String[] getUserIds()
- setUserIds
  
  public void setUserIds(java.lang.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 java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- getSortOrder
  
  public int getSortOrder()
- setSortOrder
  
  public void setSortOrder(int sortOrder)
- getFindResultAccessMode
  
  public FindResultAccessMode getFindResultAccessMode()
- setFindResultAccessMode
  
  public void setFindResultAccessMode(FindResultAccessMode findResultAccessMode)

Class FindUserInfo

Field Summary

Fields inherited from class byps.BValueClass

Constructor Summary

Method Summary

Methods inherited from class byps.BValueClass

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details