Package lumis.portal.user

Class UserAttribute

  • public class UserAttribute
extends java.lang.Object
    Entity that defines attributes that may be stored on users.
    Since:
    11.0.0
    Version:
    $Revision$ $Date$

    • Constructor Detail

      • UserAttribute

        public UserAttribute​(java.lang.String id,
                     IMonitorField.DataType dataType)
        Creates a new user attribute.
        Parameters:
        id - the attribute identifier.
        dataType - the attribute data type.
        Since:
        11.0.0

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the identifier of this user attribute.
        Returns:
        the identifier of this user attribute.
        Since:
        11.0.0

      • getLabel

        public java.lang.String getLabel()
        Returns the label of this attribute (yet to be localized using getStringResourcePath()).
        Returns:
        the label of this attribute.
        Since:
        11.0.0
        See Also:
        getLocalizedLabel()

      • getLocalizedLabel

        public java.lang.String getLocalizedLabel()
        Returns the result of localizing getLabel() using getStringResourcePath() using the current session's locale.
        Returns:
        the localized label.
        Since:
        11.0.0

      • setLabel

        public void setLabel​(java.lang.String label)
        Sets the label for this attribute.
        Parameters:
        label - the label, that may be a localization key for getStringResourcePath().
        Since:
        11.0.0

      • getDataType

        public IMonitorField.DataType getDataType()
        Returns the data type of this attribute.
        Returns:
        the data type.
        Since:
        11.0.0

      • getStringResourcePath

        public java.lang.String getStringResourcePath()
        Returns the string resource path used for localizing the attribute label.
        Returns:
        the string resource path.
        Since:
        11.0.0

      • setStringResourcePath

        public void setStringResourcePath​(java.lang.String stringResourcePath)
        Sets the string resource path used for localizing the attribute label.
        Parameters:
        stringResourcePath - the string resource path.
        Since:
        11.0.0

      • isFromModule

        public boolean isFromModule()
        Returns whether this attribute is defined in a module.
        Returns:
        true if this attribute is defined in a module, false otherwise.
        Since:
        11.0.0

      • setFromModule

        public void setFromModule​(boolean fromModule)
        Sets whether this attribute is defined in a module.
        Parameters:
        fromModule - true if this attribute is defined in a module, false otherwise.
        Since:
        11.0.0

      • identifyUser

        public boolean identifyUser()
        Returns the identifyUser.
        Returns:
        the identifyUser
        Since:
        12.3.0

      • setIdentifyUser

        public void setIdentifyUser​(boolean identifyUser)
        Sets the identifyUser.
        Parameters:
        identifyUser - the identifyUser value to set.
        Since:
        12.3.0

      • getUserAttributeId

        public java.lang.String getUserAttributeId()
        Returns the userAttributeId.
        Returns:
        the userAttributeId
        Since:
        14.0.0

      • isShared

        public boolean isShared()
        Returns the isShared.
        Returns:
        the isShared
        Since:
        14.0.0

      • setShared

        public void setShared​(boolean isShared)
        Sets the isShared.
        Parameters:
        isShared - the isShared value to set.
        Since:
        14.0.0

      • getServiceInstanceId

        public java.lang.String getServiceInstanceId()
        Returns the serviceInstanceId.
        Returns:
        the serviceInstanceId
        Since:
        14.0.0

      • setServiceInstanceId

        public void setServiceInstanceId​(java.lang.String serviceInstanceId)
        Sets the serviceInstanceId.
        Parameters:
        serviceInstanceId - the serviceInstanceId value to set.
        Since:
        14.0.0

      • setUserAttributeId

        protected void setUserAttributeId​(java.lang.String userAttributeId)
        Sets the userAttributeId.
        Parameters:
        userAttributeId - the userAttributeId value to set.
        Since:
        14.0.0

      • isIdentifyUser

        public boolean isIdentifyUser()
        Returns the identifyUser.
        Returns:
        the identifyUser
        Since:
        14.0.0