Package de.elo.ix.client

Class UserProfile

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.UserProfile
All Implemented Interfaces:
Serializable
public class UserProfile extends ValueClass implements Serializable
User profile options

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • options

      protected KeyValue[] options
      Options as name-value-pairs. This array contains the sum of default options, group options and user options.
      See Also:

    • userId

      protected String userId
      The user name or UserProfileC.USERID_ALL, if the options for all users are represented by this object. The values null or empty are equal to UserProfileC.USERID_ALL.

    • excludeGroupValues

      protected boolean excludeGroupValues
      Do not read values of option groups. Only valid for checkoutUserProfile.
      Since:
      7.00.040.014

    • excludeDefaultValues

      protected boolean excludeDefaultValues
      Do not read values for all users. Only valid for checkoutUserProfile.
      Since:
      7.00.040.014

    • userOptions

      protected KeyValue[] userOptions
      Options as name-value-pairs. This array contains the options defined for the given user. Read-only.
      Since:
      8.00.010.001
      See Also:

    • groupOptions

      protected KeyValue[] groupOptions
      Options as name-value-pairs. This array contains the options defined for the users option group. Read-only.
      Since:
      8.00.010.001
      See Also:

    • defaultOptions

      protected KeyValue[] defaultOptions
      Options as name-value-pairs. This array contains the default options valid for all users. Read-only.
      Since:
      8.00.010.001
      See Also:

    • groupId

      protected int groupId
      The users option group ID. This value is -1, if the user is not member of an option group. Read-only.
      Since:
      8.00.010.001

    • includeAllGroupAndDefaultOptions

      protected boolean includeAllGroupAndDefaultOptions
      Include all group and default options. Set this member as true, if all group and default options shall be returned. If the value is false, only those options are returned that are not particularly defined for the user.
      Since:
      10.17.040.004

  • Constructor Details

    • UserProfile

      public UserProfile()

    • UserProfile

      public UserProfile(KeyValue[] options, String userId)

  • Method Details

    • getOptions

      public KeyValue[] getOptions()

    • setOptions

      public void setOptions(KeyValue[] options)

    • getUserId

      public String getUserId()

    • setUserId

      public void setUserId(String userId)

    • isExcludeGroupValues

      public boolean isExcludeGroupValues()

    • setExcludeGroupValues

      public void setExcludeGroupValues(boolean excludeGroupValues)

    • isExcludeDefaultValues

      public boolean isExcludeDefaultValues()

    • setExcludeDefaultValues

      public void setExcludeDefaultValues(boolean excludeDefaultValues)

    • getUserOptions

      public KeyValue[] getUserOptions()

    • setUserOptions

      public void setUserOptions(KeyValue[] userOptions)

    • getGroupOptions

      public KeyValue[] getGroupOptions()

    • setGroupOptions

      public void setGroupOptions(KeyValue[] groupOptions)

    • getDefaultOptions

      public KeyValue[] getDefaultOptions()

    • setDefaultOptions

      public void setDefaultOptions(KeyValue[] defaultOptions)

    • getGroupId

      public int getGroupId()

    • setGroupId

      public void setGroupId(int groupId)

    • isIncludeAllGroupAndDefaultOptions

      public boolean isIncludeAllGroupAndDefaultOptions()

    • setIncludeAllGroupAndDefaultOptions

      public void setIncludeAllGroupAndDefaultOptions(boolean includeAllGroupAndDefaultOptions)

    • toString

      public String toString()
      Overrides:
      toString in class Object