Package org.exoplatform.social.core.profileproperty

Interface ProfilePropertyService

public interface ProfilePropertyService

  • Field Details

  • Method Details

    • getPropertySettings

      List<ProfilePropertySetting> getPropertySettings()
      Retrive the list of all ProfilePropertySetting objects
      Returns:
      List of ProfilePropertySetting

    • getSynchronizedPropertySettings

      List<ProfilePropertySetting> getSynchronizedPropertySettings()
      Retrive the list of synchronized ProfilePropertySetting objects
      Returns:
      List of ProfilePropertySetting

    • getProfileSettingById

      ProfilePropertySetting getProfileSettingById(Long id)
      Retrieves the ProfileProperty item with given ProfilePropertySetting propertyName
      Returns:
      ProfilePropertySetting if exist or null if not

    • getProfileSettingByName

      ProfilePropertySetting getProfileSettingByName(String name)
      Retrieves the ProfileProperty item with given ProfilePropertySetting propertyName
      Returns:
      ProfilePropertySetting if exist or null if not

    • createPropertySetting

      ProfilePropertySetting createPropertySetting(ProfilePropertySetting profilePropertySetting) throws org.exoplatform.commons.ObjectAlreadyExistsException
      Creates a new ProfilePropertySetting object
      Parameters:
      profilePropertySetting - ProfilePropertySetting
      Returns:
      newly created ProfilePropertySetting
      Throws:
      org.exoplatform.commons.ObjectAlreadyExistsException

    • updatePropertySetting

      void updatePropertySetting(ProfilePropertySetting profilePropertySetting)
      Updates the given ProfilePropertySetting object
      Parameters:
      profilePropertySetting - ProfilePropertySetting

    • deleteProfilePropertySetting

      void deleteProfilePropertySetting(Long id)
      Deletes the ProfilePropertySetting object with given Id
      Parameters:
      id - Long

    • isGroupSynchronizedEnabledProperty

      boolean isGroupSynchronizedEnabledProperty(Long id)
      Checks if the given ProfilePropertySetting object can be synchronized with a group
      Parameters:
      id - ProfilePropertySetting identifier
      Returns:
      Boolean

    • getPropertySettingNames

      List<String> getPropertySettingNames()
      Retreive the list List of String of property settings names
      Returns:
      List of String

    • addProfilePropertyPlugin

      void addProfilePropertyPlugin(org.exoplatform.container.component.ComponentPlugin profilePropertyInitPlugin)

    • isDefaultProperties

      boolean isDefaultProperties(ProfilePropertySetting propertySetting)
      Checks if the current property is a default property
      Parameters:
      propertySetting -
      Returns:
      Boolean : true if the current property is a default property

    • getUnhiddenableProfileProperties

      List<String> getUnhiddenableProfileProperties()
      Gets unhiddenable properties
      Returns:
      List of String

    • getExcludedQuickSearchProperties

      List<String> getExcludedQuickSearchProperties()
      Gets excluded quick search properties
      Returns:
      List of String

    • isPropertySettingHiddenable

      boolean isPropertySettingHiddenable(Long id)
      Checks if property is hiddenable
      Parameters:
      id - ProfilePropertySetting identifier
      Returns:
      true if property is hiddenbale and false otherwise

    • hidePropertySetting

      void hidePropertySetting(long userIdentityId, long profilePropertyId)
      Hide profile property setting
      Parameters:
      userIdentityId - user identity id
      profilePropertyId - profile property id

    • showPropertySetting

      void showPropertySetting(long userIdentityId, long profilePropertyId)
      Show profile property setting
      Parameters:
      userIdentityId - user identity id
      profilePropertyId - profile property id

    • getHiddenProfilePropertyIds

      List<Long> getHiddenProfilePropertyIds(long userIdentityId)
      Get hidden profile property Ids
      Parameters:
      userIdentityId - user identity ide
      Returns:
      List of Long

    • getExcludedAnalyticsIndexProperties

      List<String> getExcludedAnalyticsIndexProperties()
      Gets excluded analytics index properties
      Returns:
      List of String