Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Interface IntrospectiveUser

All Superinterfaces:
User
All Known Implementing Classes:
DbUser, LdapUser, SimpleUserAdapter, UserProxy

public interface IntrospectiveUser
extends User

This User subinterface adds the ability to query what optional capabilities are supported in this User implementation. It is added as a subinterface to preserve backward compatibility with older User implementations. User interfaces may query an IntrospectiveUser object instance before deciding whether or not to present those capabilities in the interface.


Method Summary
 boolean isGetPasswordHashSupported()
          Indicates whether retrieving a password hash is supported for this user.
 boolean isPropertyEditSupported()
          Indicates whether the property methods (get, set, delete, etc.) are supported.
 boolean isReadOnly()
          Convenience method - returns true if the user is in a 'read only' mode - that is, none of the setter methods are implemented.
 boolean isSetEmailSupported()
          Indicates whether setting the email address is supported for this user.
 boolean isSetEmailVisibleSupported()
          Indicates whether setting the visibility of the email address is supported for this user.
 boolean isSetNameSupported()
          Indicates whether setting the full name is supported for this user.
 boolean isSetNameVisibleSupported()
          Indicates whether setting the visibility of the name is supported for this user.
 boolean isSetPasswordHashSupported()
          Indicates whether modifying the hash of the user's password is supported for this user.
 boolean isSetPasswordSupported()
          Indicates whether modifying the user's password is supported.
 
Methods inherited from interface com.jivesoftware.base.User
deleteProperty, getCreationDate, getEmail, getID, getModificationDate, getName, getPasswordHash, getPermissions, getProperty, getPropertyNames, getUsername, isAuthorized, isEmailVisible, isNameVisible, setCreationDate, setEmail, setEmailVisible, setModificationDate, setName, setNameVisible, setPassword, setPasswordHash, setProperty
 

Method Detail

isSetPasswordSupported

boolean isSetPasswordSupported()
Indicates whether modifying the user's password is supported.

Returns:
true if modifying the user's password is supported.

isGetPasswordHashSupported

boolean isGetPasswordHashSupported()
Indicates whether retrieving a password hash is supported for this user.

Returns:
true if you can retrieve a password hash.

isSetPasswordHashSupported

boolean isSetPasswordHashSupported()
Indicates whether modifying the hash of the user's password is supported for this user.

Returns:
true if setting the hash is supported.

isSetNameSupported

boolean isSetNameSupported()
Indicates whether setting the full name is supported for this user.

Returns:
true if setting the name is supported.

isSetEmailSupported

boolean isSetEmailSupported()
Indicates whether setting the email address is supported for this user.

Returns:
true if setting the email is supported.

isSetNameVisibleSupported

boolean isSetNameVisibleSupported()
Indicates whether setting the visibility of the name is supported for this user.

Returns:
true if setting the name visibility flag is supported.

isSetEmailVisibleSupported

boolean isSetEmailVisibleSupported()
Indicates whether setting the visibility of the email address is supported for this user.

Returns:
true if setting the email visibility flag is supported.

isPropertyEditSupported

boolean isPropertyEditSupported()
Indicates whether the property methods (get, set, delete, etc.) are supported.

Returns:
true if the property methods are supported.

isReadOnly

boolean isReadOnly()
Convenience method - returns true if the user is in a 'read only' mode - that is, none of the setter methods are implemented.

Returns:
true if the user is in 'read only' mode, false otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.