com.jivesoftware.community.webservices
Interface ProfileFieldService

public interface ProfileFieldService

Defines methods used to create, access, update, and remove profile fields data. All user profile data is managed via the ProfileService.

Method Summary

ProfileField	createProfileField(ProfileField field) Creates a new profile field.
void	deleteProfileField(long fieldID) Removes a profile field from the system.
void	editProfileField(ProfileField field) Edits the profile field data.
void	editProfileFieldOptions(ProfileField field) Edits the ProfileFieldOption objects for a profile field.
ProfileField	getProfileField(long fieldID) Gets a profile field object by its id.
ProfileField[]	getProfileFields() Gets the list of all profile fields in the system.
void	setIndex(long fieldID, int newIndex) Sets the index of the profile field.

Method Detail

createProfileField

ProfileField createProfileField(ProfileField field)

Creates a new profile field.

Parameters:

field - the new profile field to create.

Returns:

the new profile field

getProfileField

ProfileField getProfileField(long fieldID)

Gets a profile field object by its id.

Parameters:

fieldID - the id of the profile field.

Returns:

the profile field object corresponding to the fieldID.

editProfileField

void editProfileField(ProfileField field)

Edits the profile field data.

Parameters:

field - the profile field to edit.

editProfileFieldOptions

void editProfileFieldOptions(ProfileField field)

Edits the ProfileFieldOption objects for a profile field.

Parameters:

field - the field containing the edited ProfileFieldOption objects.

deleteProfileField

void deleteProfileField(long fieldID)

Removes a profile field from the system. This method will also remove all the user data and ProfileFieldOption objects associated with the field.

Parameters:

fieldID - the id of the field to remove

getProfileFields

ProfileField[] getProfileFields()

Gets the list of all profile fields in the system.

Returns:

a list of all profile fields in the system.

setIndex

void setIndex(long fieldID,
              int newIndex)

Sets the index of the profile field. The index value can be used to display the fields in an arbitrary order. Index values are from 0 to getProfileFields().size() - 1.

Parameters:

fieldID - the profile field id to adjust the index of.

newIndex - the new index value for the field.