com.jivesoftware.community.user.profile
Interface ProfileFieldManager

All Superinterfaces:

JiveManager

public interface ProfileFieldManager
extends JiveManager

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

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.
List<ProfileField>	getCustomFields() Returns a list of all profile fields added by the administrator.
List<ProfileField>	getDefaultFields() Returns a list of all default profile fields.
List<ProfileField>	getExternallyManagedFields() Returns a list of all profile fields whose values are pulled from an external system such as LDAP.
List<ProfileField>	getFilterableFields() Returns a list of all filterable profile fields.
ProfileField	getProfileField(long fieldID) Gets a profile field object by its id.
ProfileField	getProfileField(String profileFieldName) Gets a profile field object by its name or null if the field name is not found.
List<ProfileField>	getProfileFields() Gets the list of all profile fields in the system.
void	setIndex(ProfileField field, int newIndex) Sets the index of the profile field.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy

Method Detail

createProfileField

ProfileField createProfileField(ProfileField field)
                                throws com.jivesoftware.util.AlreadyExistsException,
                                       UnauthorizedException

Creates a new profile field.

Parameters:

field - the new profile field to create.

Returns:

the new profile field, or null if one of the same name or ID already exists.

Throws:

com.jivesoftware.util.AlreadyExistsException - if a field with that ID or name already exists.

UnauthorizedException - if not the system admin.

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.

getProfileField

ProfileField getProfileField(String profileFieldName)

Gets a profile field object by its name or null if the field name is not found.

Parameters:

profileFieldName - the name of the profile field.

Returns:

the profile field object corresponding to the name.

getDefaultFields

List<ProfileField> 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.

getCustomFields

List<ProfileField> getCustomFields()

Returns a list of all profile fields added by the administrator.

Returns:

a list of all profile fields added by the administrator.

getExternallyManagedFields

List<ProfileField> getExternallyManagedFields()

Returns a list of all profile fields whose values are pulled from an external system such as LDAP.

Returns:

a list of all profile fields whose values are pulled from an external system such as LDAP.

getFilterableFields

List<ProfileField> getFilterableFields()

Returns a list of all filterable profile fields.

Returns:

a list of all filterable profile fields.

editProfileField

void editProfileField(ProfileField 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(ProfileField field)
                             throws UnauthorizedException

Edits the ProfileFieldOption objects for a profile field.

Parameters:

field - the field containing the edited ProfileFieldOption objects.

Throws:

UnauthorizedException - if not the system admin.

deleteProfileField

void deleteProfileField(long fieldID)
                        throws UnauthorizedException

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

Throws:

UnauthorizedException - if not the system admin.

getProfileFields

List<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(ProfileField field,
              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. The supplied index will be adjusted to be one more than the greatest 'default' field index. Default fields always come before admin defined fields, and their individual indices are not configurable.

Parameters:

field - the profile field to adjust the index of.

newIndex - the new index value for the field.

Throws:

UnauthorizedException - if not the system admin.