Package org.exoplatform.social.core.profileproperty

Interface ProfilePropertyService

public interface ProfilePropertyService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LABELS_OBJECT_TYPE

Method Summary

Modifier and Type	Method	Description
void	addProfilePropertyPlugin(org.exoplatform.container.component.ComponentPlugin profilePropertyInitPlugin)
ProfilePropertySetting	createPropertySetting(ProfilePropertySetting profilePropertySetting)	Creates a new ProfilePropertySetting object
void	deleteProfilePropertySetting(Long id)	Deletes the ProfilePropertySetting object with given Id
ProfilePropertySetting	getProfileSettingById(Long id)	Retrieves the ProfileProperty item with given ProfilePropertySetting propertyName
ProfilePropertySetting	getProfileSettingByName(String name)	Retrieves the ProfileProperty item with given ProfilePropertySetting propertyName
List<String>	getPropertySettingNames()	Retreive the list List of String of property settings names
List<ProfilePropertySetting>	getPropertySettings()	Retrive the list of all ProfilePropertySetting objects
List<ProfilePropertySetting>	getSynchronizedPropertySettings()	Retrive the list of synchronized ProfilePropertySetting objects
boolean	hasChildProperties(ProfilePropertySetting propertySetting)	Checks if the current property has child properties
boolean	isDefaultProperties(ProfilePropertySetting propertySetting)	Checks if the current property is a default propertie
boolean	isGroupSynchronizedEnabledProperty(ProfilePropertySetting profilePropertySetting)	Checks if the given ProfilePropertySetting object can be synchronized with a group
void	updatePropertySetting(ProfilePropertySetting profilePropertySetting)	Updates the given ProfilePropertySetting object

Field Details

LABELS_OBJECT_TYPE

static final String LABELS_OBJECT_TYPE

See Also:

• Constant Field Values

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(ProfilePropertySetting profilePropertySetting)

Checks if the given ProfilePropertySetting object can be synchronized with a group

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)

hasChildProperties

boolean hasChildProperties(ProfilePropertySetting propertySetting)

Checks if the current property has child properties

Parameters:

propertySetting -

Returns:

Boolean : true if the current property has child properties

isDefaultProperties

boolean isDefaultProperties(ProfilePropertySetting propertySetting)

Checks if the current property is a default propertie

Parameters:

propertySetting -

Returns:

Boolean : true if the current property is a default propertie