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

WSProfileField	createProfileField(WSProfileField field) Creates a new profile field.
void	deleteProfileField(long fieldID) Removes a profile field from the system.
void	editProfileField(WSProfileField field) Edits the profile field data.
void	editProfileFieldOptions(WSProfileField field) Edits the com.jivesoftware.community.profile.ProfileFieldOption objects for a profile field.
WSProfileField[]	getDefaultFields() Returns a list of all default profile fields.
WSProfileField	getProfileField(long fieldID) Gets a profile field object by its id.
WSProfileField[]	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

WSProfileField createProfileField(WSProfileField field)
                                  throws UnauthorizedException

Creates a new profile field.

Parameters:

field - the new profile field to create.

Returns:

the new profile field

Throws:

UnauthorizedException - if not the system admin.

getProfileField

WSProfileField 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(WSProfileField field)
                      throws UnauthorizedException

Edits the profile field data.

Parameters:

field - the profile field to edit.

Throws:

UnauthorizedException - if not the system admin.

editProfileFieldOptions

void editProfileFieldOptions(WSProfileField field)
                             throws UnauthorizedException

Edits the com.jivesoftware.community.profile.ProfileFieldOption objects for a profile field.

Parameters:

field - the field containing the edited com.jivesoftware.community.profile.ProfileFieldOption objects.

Throws:

UnauthorizedException

deleteProfileField

void deleteProfileField(long fieldID)
                        throws UnauthorizedException

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

Parameters:

fieldID - the id of the field to remove

Throws:

UnauthorizedException - if not the system admin.

getProfileFields

WSProfileField[] 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)
              throws UnauthorizedException

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.

Throws:

UnauthorizedException - if not the system admin.

getDefaultFields

WSProfileField[] getDefaultFields()

Returns a list of all default profile fields. These fields need not be shown, but they cannot be deleted.

Returns:

a list of all default profile fields. These fields need not be shown, but they cannot be deleted.