Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles
Class ProfileFieldManagerImpl

java.lang.Object
  extended by com.jivesoftware.profiles.ProfileFieldManagerImpl
All Implemented Interfaces:
ProfileFieldManager

public class ProfileFieldManagerImpl
extends java.lang.Object
implements ProfileFieldManager


Field Summary
protected static java.lang.String SHIFT_FIELD_INDEX_DOWN
           
protected static java.lang.String SHIFT_FIELD_INDEX_UP
           
 
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.
static ProfileFieldManager getInstance()
          Provides singleton access to a ProfileFieldManagerImpl instance.
 ProfileField getProfileField(long fieldID)
          Gets a profile field object by its id.
 java.util.List 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SHIFT_FIELD_INDEX_UP

protected static final java.lang.String SHIFT_FIELD_INDEX_UP
See Also:
Constant Field Values

SHIFT_FIELD_INDEX_DOWN

protected static final java.lang.String SHIFT_FIELD_INDEX_DOWN
See Also:
Constant Field Values
Method Detail

getInstance

public static ProfileFieldManager getInstance()
Provides singleton access to a ProfileFieldManagerImpl instance.


createProfileField

public ProfileField createProfileField(ProfileField field)
Description copied from interface: ProfileFieldManager
Creates a new profile field.

Specified by:
createProfileField in interface ProfileFieldManager
Parameters:
field - the new profile field to create.
Returns:
the new profile field

getProfileField

public ProfileField getProfileField(long fieldID)
Description copied from interface: ProfileFieldManager
Gets a profile field object by its id.

Specified by:
getProfileField in interface ProfileFieldManager
Parameters:
fieldID - the id of the profile field.
Returns:
the profile field object corresponding to the fieldID.

editProfileField

public void editProfileField(ProfileField field)
Description copied from interface: ProfileFieldManager
Edits the profile field data.

Specified by:
editProfileField in interface ProfileFieldManager
Parameters:
field - the profile field to edit.

editProfileFieldOptions

public void editProfileFieldOptions(ProfileField field)
Description copied from interface: ProfileFieldManager
Edits the ProfileFieldOption objects for a profile field.

Specified by:
editProfileFieldOptions in interface ProfileFieldManager
Parameters:
field - the field containing the edited ProfileFieldOption objects.

deleteProfileField

public void deleteProfileField(long fieldID)
Description copied from interface: ProfileFieldManager
Removes a profile field from the system. This method will also remove all the user data and ProfileFieldOption objects associated with the field.

Specified by:
deleteProfileField in interface ProfileFieldManager
Parameters:
fieldID - the id of the field to remove

getProfileFields

public java.util.List getProfileFields()
Description copied from interface: ProfileFieldManager
Gets the list of all profile fields in the system.

Specified by:
getProfileFields in interface ProfileFieldManager
Returns:
a list of all profile fields in the system.

setIndex

public void setIndex(ProfileField field,
                     int newIndex)
Description copied from interface: ProfileFieldManager
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.

Specified by:
setIndex in interface ProfileFieldManager
Parameters:
field - the profile field to adjust the index of.
newIndex - the new index value for the field.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.