oracle.panama.model
Interface User

All Superinterfaces:

ModelObject, XMLObject

public interface User

extends ModelObject

A user is the identity of the current user. Each user has it's own home folder and can access services that are acessible to his groups. The user implementation may access another provisionoing system to manage the information about the user.

Field Summary

Type	Field
static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier.

Method Summary

Type	Method
void	addAddress(AlertAddress address) Deprecated. As of IAS 1.2, replaced by addDeviceAddress(DeviceAddress)
void	addDeviceAddress(DeviceAddress deviceAddress) Add a device address to the user's list of device addresses
void	addGroup(Group group) Add a group to the list of user's groups
void	addLocationMark(LocationMark locationMark) Add a new LocationMark to the list of the user's LocationMarks
void	addRole(Role role) Add a role to the list of user's roles.
boolean	checkPassword(java.lang.String password) Check if the user is enabled and the password is correct.
boolean	checkPin(java.lang.String pin) Check if the user is enabled and the voice password is correct.
DeviceAddress	createDeviceAddress(java.lang.String name, DeliveryType deliveryType, java.lang.String address) Create a new device address for a given delivery type and address.
Presets	createPresets(PresetCategory category) Create a user's presets relation in the category.
Presets	createPresets(PresetCategory category, java.lang.String name) Create a user's presets relation with given name in the category.
Profile	createProfile(java.lang.String name) Create a new customization profile for the user.
void	deletePresets(PresetCategory category, java.lang.Long id) Delete a user presets relation with given name in the specified category.
void	deletePresets(PresetCategory category, java.lang.String name) Delete a user presets relation with given name in the specified category.
Service[]	getAccessibleUserServices() Get all valid and visible services in the user's root folder.
java.lang.String	getAccountNumber() Gets the account number (a numeric string) which is used to identify the user accessing iASW from a voice device.
AlertAddress[]	getAddresses() Deprecated. As of IAS 1.2, replaced by getDeviceAddresses()
int	getAge() Gets the age of the user.
java.util.Vector	getAllPresets(PresetCategory category) Gets all of the user's presets in the given preset category.
java.util.Vector	getAllProfiles() Get all of the customization profiles for the user.
Service[]	getAllUserServices() Get all services (including invalid and invisible) services in the user's root folder.
java.lang.String	getCountry() Returns the country of this user.
java.util.GregorianCalendar	getDateOfBirth() Gets the date of birth of the user.
AlertAddress	getDefaultAlertAddress() Deprecated. As of IASW 1.2, replaced by getDefaultDeviceAddress()
DeviceAddress	getDefaultDeviceAddress() Gets the default device address of this user.
LocationMark	getDefaultLocationMark() Gets the default location mark of the user.
Profile	getDefaultProfile() Gets the default customization profile of the user.
DeviceAddress[]	getDeviceAddresses() Gets the list of user's device addresses
java.lang.String	getDeviceId() Gets the device id, an identification sent by the device that can be used to automatically set up the user's session.
java.lang.String	getDisplayName() Gets the display name of the user.
java.lang.String	getExternalId() Gets the external id of the user, that can be used to identify the user in external provisioning systems.
Gender	getGender() Gets the gender of the user.
java.lang.String	getGlobalUID() Gets the global unique ID of the user, that is an optional attribute in Oracle Internet Directory OID.
Group[]	getGroups() Gets all the groups that the user is a member.
Folder	getHomeFolder() Gets the user's root folder.
java.lang.String	getLanguage() Returns the language of the user.
java.util.Locale	getLocale() Returns the locale of the user.
LocationMark[]	getLocationMarks() Get the list of the user's LocationMarks
java.lang.String	getLocationPrivacyDirective() Gets the Location Privacy Directive of the user
java.lang.String	getMobileID() Gets the mobile ID of the user.
Service[]	getOwnedUserServices() Get all services owned by the user (including services in the user's root folder and subfolders).
java.lang.String	getPasswordHint() Gets the password hint of the user.
java.lang.String	getPasswordHintAnswer() Gets the password hint answer of the user.
Presets	getPresets(PresetCategory category, java.lang.String name) Gets the user's presets relation with given name.
Role[]	getRoles() Gets the roles assigned to the user.
java.util.TimeZone	getTimeZone() Returns the time zone of the user.
UserType	getUserType() Gets the user type which indicates the type of the user as anonymous, virtual, or registered.
Service[]	getValidUserServices() Get all valid services in the user's root folder.
boolean	isAdministrator()
boolean	isAnonymous()
boolean	isAutoLocate()
boolean	isCallable(Service service) Test if this user has permissions to call the service
boolean	isDesigner()
boolean	isDiscloseIdentity() Checks whether the identity of the user can be disclosed to external applications.
boolean	isDiscloseLocation() Checks whether the location of the user can be disclosed to external applications.
boolean	isEnabled() Checks if the user is enabled for accessing the portals.
boolean	isFolderExpanded(Folder folder) Check if the folder should be expanded depending on the user preference.
boolean	isHelpDesk()
DeviceAddress	lookupDeviceAddress(long id) Lookup a Logical device by id.
DeviceAddress	lookupDeviceAddress(java.lang.String name) Lookup a device address by name.
Presets	lookupPresets(java.lang.Long id) Look up the user's preset by id.
Profile	lookupProfile(java.lang.Long id) Look up the user's customization profile by id.
Profile	lookupProfile(java.lang.String name) Look up the user's customization profile by name.
Service	lookupService(java.lang.String shortName)
void	refreshFromOID() refresh the wireless user info based on OID user attributes
void	removeAddress(AlertAddress address) Deprecated. As of IAS 1.2, replaced by removeDeviceAddress(DeviceAddress)
void	removeAllGroups() Remove the current user from all groups that the user is a member.
void	removeAllRoles() Remove the current user from all roles that the user is assigned.
void	removeDeviceAddress(DeviceAddress deviceAddress) Remove a device address from the user's list of device adddresses.
void	removeGroup(Group group) Remove a group from the list of user's groups.
void	removeLocationMark(LocationMark LocationMark) Remove a LocationMark from the list of the user's LocationMarks.
void	removeRole(Role role) Remove a role from the list of user's roles.
void	setAccountNumber(java.lang.String accountNumber)
void	setAdministrator(boolean administrator)
void	setAnonymous(boolean anonymous)
void	setAutoLocate(boolean autoLocate)
void	setCountry(java.lang.String country) Sets the country of this user.
void	setDateOfBirth(java.util.GregorianCalendar dateOfBirth) Sets the date of birth of the user
void	setDefaultAlertAddress(AlertAddress alertAddress) Deprecated. As of IAS 1.2, replaced by setDefaultDeviceAddress(DeviceAddress)
void	setDefaultDeviceAddress(DeviceAddress deviceAddress) Sets the default device address of the user.
void	setDefaultLocationMark(LocationMark locationMark) Sets the default LocationMark of the user.
void	setDefaultProfile(Profile profile) Sets the default customization profile of the user.
void	setDesigner(boolean designer)
void	setDiscloseIdentity(boolean discloseIdentity) Sets the value that specifies whether the identity of the user can be disclosed to external applications.
void	setDiscloseLocation(boolean discloseLocation) Sets the value that specifies whether the location of the user can be disclosed to external applications.
void	setDisplayName(java.lang.String displayName) Sets the display name of the user.
void	setEnabled(boolean enabled) Sets the value that specifies whether the user is enabled for accessing the portals.
void	setExternalId(java.lang.String externalId) Sets the external id of the user, that can be used to identify the user in external provisioning systems.
void	setFolderExpanded(Folder folder, boolean expand) Set expanded or collapsed state of the folder depending on the user preference.
void	setGender(Gender gender) Sets the gender of the user.
void	setGroups(Group[] groups) Sets all the groups that the user is a member.
void	setHomeFolder(Folder folder) Sets the user's root folder.
void	setLanguage(java.lang.String language) Sets the language of the user.
void	setLocale(java.util.Locale locale) Sets the locale of the user.
void	setLocationPrivacyDirective(java.lang.String directive) Sets the LocationPrivacyDirective of the user.
void	setMobileID(java.lang.String mobileID) Sets the mobile ID of the user.
void	setPassword(java.lang.String password) Sets the user password.
void	setPasswordHint(java.lang.String hint) Sets the password hint of the user.
void	setPasswordHintAnswer(java.lang.String passwordHintAnswer) Sets the password hint answer of the user.
void	setPin(java.lang.String pin)
void	setRoles(Role[] roles) Sets the roles assigned to the user.
void	setTimeZone(java.util.TimeZone timeZone) Sets the time zone of the user.
void	setUserType(UserType userType) Sets the user type which indicates the type of the user as anonymous, virtual, or registered.

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier.

TYPEID

public static final int TYPEID

The type id of this class.

Method Detail

getGlobalUID

public java.lang.String getGlobalUID()

Gets the global unique ID of the user, that is an optional attribute in Oracle Internet Directory OID.

Returns:

the global unique ID or null if not set.

refreshFromOID

public void refreshFromOID()

refresh the wireless user info based on OID user attributes

getAccountNumber

public java.lang.String getAccountNumber()

Gets the account number (a numeric string) which is used to identify the user accessing iASW from a voice device.

Returns:

the account number.

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)

setPin

public void setPin(java.lang.String pin)

checkPin

public boolean checkPin(java.lang.String pin)

Check if the user is enabled and the voice password is correct.

Parameters:

pin - the pin to check in plain text.

Returns:

true if it's the same otherwise false.

setPassword

public void setPassword(java.lang.String password)

Sets the user password. This method uses the algorithm specified in the System.properties variable "algorithm.password" to scramble the value.

Parameters:

password - the password in plain text, the password is immediately scrambled

getPasswordHint

public java.lang.String getPasswordHint()

Gets the password hint of the user.

Returns:

the password hint or null if not set.

setPasswordHint

public void setPasswordHint(java.lang.String hint)

Sets the password hint of the user.

Parameters:

hint - the password hint.

getPasswordHintAnswer

public java.lang.String getPasswordHintAnswer()

Gets the password hint answer of the user.

Returns:

the password hint or null if not set.

setPasswordHintAnswer

public void setPasswordHintAnswer(java.lang.String passwordHintAnswer)

Sets the password hint answer of the user.

Returns:

the password hint or null if not set.

checkPassword

public boolean checkPassword(java.lang.String password)

Check if the user is enabled and the password is correct.

Parameters:

password - the password to check in plain text.

Returns:

true if it's the same otherwise false.

getGroups

public Group[] getGroups()

Gets all the groups that the user is a member.

Returns:

Group[] the groups the user belongs to.

See Also:

setGroups(oracle.panama.model.Group[])

setGroups

public void setGroups(Group[] groups)

Sets all the groups that the user is a member.

Parameters:

groups - the list of groups the user belongs to

See Also:

getGroups()

addGroup

public void addGroup(Group group)

Add a group to the list of user's groups

Parameters:

group - the new group

See Also:

removeGroup(oracle.panama.model.Group)

removeGroup

public void removeGroup(Group group)

Remove a group from the list of user's groups.

Parameters:

group - the group to be removed

See Also:

addGroup(oracle.panama.model.Group)

removeAllGroups

public void removeAllGroups()

Remove the current user from all groups that the user is a member.

See Also:

setGroups(oracle.panama.model.Group[])

getRoles

public Role[] getRoles()

Gets the roles assigned to the user.

Returns:

Role[] the roles the user has.

See Also:

setRoles(oracle.panama.model.Role[])

setRoles

public void setRoles(Role[] roles)

Sets the roles assigned to the user.

Parameters:

roles - the list of roles the user has

See Also:

getRoles()

addRole

public void addRole(Role role)

Add a role to the list of user's roles.

Parameters:

role - the new role

See Also:

removeRole(oracle.panama.model.Role)

removeRole

public void removeRole(Role role)

Remove a role from the list of user's roles.

Parameters:

role - the role to be removed

See Also:

addRole(oracle.panama.model.Role)

removeAllRoles

public void removeAllRoles()

Remove the current user from all roles that the user is assigned.

See Also:

setRoles(oracle.panama.model.Role[])

getHomeFolder

public Folder getHomeFolder()

Gets the user's root folder. The user's root folder also represents the home folder which is the combination of the user's root folder services and the user's group services.

Returns:

the user's "home" folder.

setHomeFolder

public void setHomeFolder(Folder folder)

Sets the user's root folder. The user's root folder also represents the home folder which is the combination of the user's root folder services and the user's group services.

Parameters:

the - user's "home" folder.

getOwnedUserServices

public Service[] getOwnedUserServices()

Get all services owned by the user (including services in the user's root folder and subfolders).

Returns:

all services owned by this user.

getAllUserServices

public Service[] getAllUserServices()

Get all services (including invalid and invisible) services in the user's root folder. The services are sorted by name, sequence number, or date of creation as specified by the default sorting rule of the site.

Returns:

a Service[] of all services in user's root folder.

getValidUserServices

public Service[] getValidUserServices()

Get all valid services in the user's root folder. The services are sorted by name, sequence number, or date of creation as specified by the default sorting rule of the site.

Returns:

a Service[] of valid services in user's root folder.

getAccessibleUserServices

public Service[] getAccessibleUserServices()

Get all valid and visible services in the user's root folder. The services are sorted by name, sequence number, or date of creation as specified by the default sorting rule of the site.

Returns:

a Service[] of valid and visible services in user's root folder.

isAdministrator

public boolean isAdministrator()

Returns:

true if this user is an Administrator.

isHelpDesk

public boolean isHelpDesk()

Returns:

true if this user is a helpdesk.

setAdministrator

public void setAdministrator(boolean administrator)

Parameters:

administrator - true if this user is an administrator otherwise false.

isDesigner

public boolean isDesigner()

Returns:

The designer property value.

See Also:

setDesigner(boolean)

setDesigner

public void setDesigner(boolean designer)

Parameters:

designer - The new value for the property.

See Also:

isDesigner()

isAnonymous

public boolean isAnonymous()

Returns:

The anonymous property value.

See Also:

setAnonymous(boolean)

setAnonymous

public void setAnonymous(boolean anonymous)

Parameters:

anonymous - the new value for the property.

See Also:

isAnonymous()

isEnabled

public boolean isEnabled()

Checks if the user is enabled for accessing the portals.

Returns:

The enabled property value.

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Sets the value that specifies whether the user is enabled for accessing the portals.

Parameters:

enabled - the new value for the property.

See Also:

isEnabled()

getDefaultAlertAddress

public AlertAddress getDefaultAlertAddress()

Deprecated. As of IASW 1.2, replaced by getDefaultDeviceAddress()

Returns:

the default AlertAddress or null if none.

setDefaultAlertAddress

public void setDefaultAlertAddress(AlertAddress alertAddress)

Deprecated. As of IAS 1.2, replaced by setDefaultDeviceAddress(DeviceAddress)

Set the default AlertAddress for "asynchronous" jobs.

Parameters:

agent - the agent.

getAddresses

public AlertAddress[] getAddresses()

Deprecated. As of IAS 1.2, replaced by getDeviceAddresses()

Get the list of the user's alert addresses

Returns:

AlertAddress[] the addresses

See Also:

#setAddresses

addAddress

public void addAddress(AlertAddress address)

Deprecated. As of IAS 1.2, replaced by addDeviceAddress(DeviceAddress)

Add a new address to the list of the user's alert addresses

Parameters:

AlertAddress - the new address

See Also:

removeAddress(oracle.panama.model.AlertAddress)

removeAddress

public void removeAddress(AlertAddress address)

Deprecated. As of IAS 1.2, replaced by removeDeviceAddress(DeviceAddress)

Remove an address from the list of the user's alert addresses. This will also delete the UserAddress object from the repository.

Parameters:

AlertAddress - the address to be removed

See Also:

addAddress(oracle.panama.model.AlertAddress)

getDefaultDeviceAddress

public DeviceAddress getDefaultDeviceAddress()

Gets the default device address of this user.

Returns:

the default DeviceAddress or null if none.

setDefaultDeviceAddress

public void setDefaultDeviceAddress(DeviceAddress deviceAddress)

Sets the default device address of the user.

Parameters:

deviceAddress - the device address

getDeviceAddresses

public DeviceAddress[] getDeviceAddresses()

Gets the list of user's device addresses

Returns:

DeviceAddress[] the device addresses

removeDeviceAddress

public void removeDeviceAddress(DeviceAddress deviceAddress)

Remove a device address from the user's list of device adddresses.

Parameters:

deviceAddress - the device address to be removed

addDeviceAddress

public void addDeviceAddress(DeviceAddress deviceAddress)

Add a device address to the user's list of device addresses

Parameters:

deviceAddress - the new device address

createDeviceAddress

public DeviceAddress createDeviceAddress(java.lang.String name,
                                         DeliveryType deliveryType,
                                         java.lang.String address)

Create a new device address for a given delivery type and address.

Parameters:

name - the not null name of the device address, mandatory

deliveryType - the delivery type, mandatory

address - the non null address, mandatory

Returns:

the device address

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(java.lang.String name)

Lookup a device address by name.

Parameters:

name - the name of the device address

Returns:

the device address

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(long id)

Lookup a Logical device by id.

Parameters:

id - the system oid

Returns:

the device address

getExternalId

public java.lang.String getExternalId()

Gets the external id of the user, that can be used to identify the user in external provisioning systems.

Returns:

the externalId property value.

See Also:

setExternalId(java.lang.String)

setExternalId

public void setExternalId(java.lang.String externalId)

Sets the external id of the user, that can be used to identify the user in external provisioning systems.

Parameters:

aExternalId - the new value for the property.

See Also:

getExternalId()

getDisplayName

public java.lang.String getDisplayName()

Gets the display name of the user.

Returns:

the displayName property value.

See Also:

setDisplayName(java.lang.String)

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the user.

Parameters:

aDisplayName - the new value for the property.

See Also:

getDisplayName()

getLocale

public java.util.Locale getLocale()

Returns the locale of the user.

Returns:

Locale the locale.

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale of the user.

Parameters:

locale - the locale.

getLanguage

public java.lang.String getLanguage()

Returns the language of the user.

A valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as: http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

Returns:

String the language ISO code.

See Also:

setLanguage(java.lang.String)

setLanguage

public void setLanguage(java.lang.String language)

Sets the language of the user.

Parameters:

String - the language ISO code.

See Also:

getLanguage()

getCountry

public java.lang.String getCountry()

Returns the country of this user. A valid ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. You can find a full list of these codes at a number of sites, such as: http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Returns:

String the country ISO code.

See Also:

setCountry(java.lang.String)

setCountry

public void setCountry(java.lang.String country)

Sets the country of this user.

Parameters:

String - the country ISO code.

See Also:

getCountry()

lookupService

public Service lookupService(java.lang.String shortName)

Parameters:

shortName - the ShortName for the Service

Returns:

the Service with the shortName

getDefaultLocationMark

public LocationMark getDefaultLocationMark()

Gets the default location mark of the user.

Returns:

the default LocationMark or null if none.

setDefaultLocationMark

public void setDefaultLocationMark(LocationMark locationMark)

Sets the default LocationMark of the user.

Parameters:

LocationMark - the LocationMark.

getLocationMarks

public LocationMark[] getLocationMarks()

Get the list of the user's LocationMarks

Returns:

LocationMark[] the LocationMarks

addLocationMark

public void addLocationMark(LocationMark locationMark)

Add a new LocationMark to the list of the user's LocationMarks

Parameters:

LocationMark - the new LocationMark

See Also:

removeLocationMark(oracle.panama.model.LocationMark)

removeLocationMark

public void removeLocationMark(LocationMark LocationMark)

Remove a LocationMark from the list of the user's LocationMarks. This will also delete the LocationMark object from the repository.

Parameters:

LocationMark - the LocationMark to be removed

See Also:

addLocationMark(oracle.panama.model.LocationMark)

isAutoLocate

public boolean isAutoLocate()

Returns:

the autoLocate approximating a LocationPrivacyDirective.

See Also:

setAutoLocate(boolean)

setAutoLocate

public void setAutoLocate(boolean autoLocate)

Parameters:

autoLocate - approximating a LocationPrivacyDirective.

See Also:

isAutoLocate()

getTimeZone

public java.util.TimeZone getTimeZone()

Returns the time zone of the user.

Returns:

TimeZone the time zone of this user.

See Also:

setTimeZone(java.util.TimeZone)

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

Sets the time zone of the user.

Parameters:

TimeZone - the new TimeZone value.

See Also:

getTimeZone()

getDefaultProfile

public Profile getDefaultProfile()

Gets the default customization profile of the user.

setDefaultProfile

public void setDefaultProfile(Profile profile)

Sets the default customization profile of the user.

createProfile

public Profile createProfile(java.lang.String name)
                      throws NameUniquenessViolationException

Create a new customization profile for the user.

Returns:

The new instance of the user profile.

Throws:

NameUniquenessViolationException - if the named profile already exists.

lookupProfile

public Profile lookupProfile(java.lang.String name)

Look up the user's customization profile by name.

Returns:

The user profile

lookupProfile

public Profile lookupProfile(java.lang.Long id)

Look up the user's customization profile by id.

Returns:

The user profile

getAllProfiles

public java.util.Vector getAllProfiles()

Get all of the customization profiles for the user.

lookupPresets

public Presets lookupPresets(java.lang.Long id)

Look up the user's preset by id.

getAllPresets

public java.util.Vector getAllPresets(PresetCategory category)

Gets all of the user's presets in the given preset category.

Returns:

A vector of Presets

getPresets

public Presets getPresets(PresetCategory category,
                          java.lang.String name)

Gets the user's presets relation with given name.

createPresets

public Presets createPresets(PresetCategory category)

Create a user's presets relation in the category.

createPresets

public Presets createPresets(PresetCategory category,
                             java.lang.String name)

Create a user's presets relation with given name in the category.

deletePresets

public void deletePresets(PresetCategory category,
                          java.lang.String name)

Delete a user presets relation with given name in the specified category. Presets should be deleted through the user so that it can be removed from the user's cache.

deletePresets

public void deletePresets(PresetCategory category,
                          java.lang.Long id)

Delete a user presets relation with given name in the specified category. Presets should be deleted through the user so that it can be removed from the user's cache.

isFolderExpanded

public boolean isFolderExpanded(Folder folder)

Check if the folder should be expanded depending on the user preference.

setFolderExpanded

public void setFolderExpanded(Folder folder,
                              boolean expand)

Set expanded or collapsed state of the folder depending on the user preference.

isDiscloseIdentity

public boolean isDiscloseIdentity()

Checks whether the identity of the user can be disclosed to external applications.

Returns:

true if the user's identity can be disclosed to external applicatio

setDiscloseIdentity

public void setDiscloseIdentity(boolean discloseIdentity)

Sets the value that specifies whether the identity of the user can be disclosed to external applications. The default value is false.

Parameters:

discloseIdentity - the new property value

isDiscloseLocation

public boolean isDiscloseLocation()

Checks whether the location of the user can be disclosed to external applications.

Returns:

true of the user's location can be disclosed to external applications.

setDiscloseLocation

public void setDiscloseLocation(boolean discloseLocation)

Sets the value that specifies whether the location of the user can be disclosed to external applications. The default value is false.

Parameters:

discloseLocation - the new property value

getUserType

public UserType getUserType()

Gets the user type which indicates the type of the user as anonymous, virtual, or registered.

Returns:

the user type

setUserType

public void setUserType(UserType userType)

Sets the user type which indicates the type of the user as anonymous, virtual, or registered.

Parameters:

userType - the new user type

getAge

public int getAge()

Gets the age of the user.

Returns:

the age of the user

getDateOfBirth

public java.util.GregorianCalendar getDateOfBirth()

Gets the date of birth of the user.

Returns:

the date of birth of the user

setDateOfBirth

public void setDateOfBirth(java.util.GregorianCalendar dateOfBirth)

Sets the date of birth of the user

Parameters:

dateOfBirth - the new property value

getGender

public Gender getGender()

Gets the gender of the user.

Returns:

the gender of the user

setGender

public void setGender(Gender gender)

Sets the gender of the user.

Parameters:

gender - the new property value

getLocationPrivacyDirective

public java.lang.String getLocationPrivacyDirective()

Gets the Location Privacy Directive of the user

Returns:

the location privacy directive. IF the user has not set her directive, the system default value is returned. The value can be one of the three Location Privacy Directive values defined in LocationPricacyManager interface: DIRECTIVE_NO_POSITION,DIRECTIVE_NO_CACHE,DIRECTIVE_ALLOW_LCP

See Also:

LocationPrivacyManager

setLocationPrivacyDirective

public void setLocationPrivacyDirective(java.lang.String directive)

Sets the LocationPrivacyDirective of the user.

Parameters:

directive - The new value for the property. the value must be one of the three Location Privacy Directive values defined in LocationPricacyManager interface: DIRECTIVE_NO_POSITION,DIRECTIVE_NO_CACHE,DIRECTIVE_ALLOW_LCP

See Also:

LocationPrivacyManager

getMobileID

public java.lang.String getMobileID()

Gets the mobile ID of the user.

Returns:

the mobileID of the user

setMobileID

public void setMobileID(java.lang.String mobileID)

Sets the mobile ID of the user.

Parameters:

mobileID - the new property value

getDeviceId

public java.lang.String getDeviceId()

Gets the device id, an identification sent by the device that can be used to automatically set up the user's session.

Returns:

the id of the users device

isCallable

public boolean isCallable(Service service)

Test if this user has permissions to call the service

Parameters:

service - the Service that we want to test

Returns:

true if the user can call the service false otherwise