<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Application Server Wireless Java API Reference
B10400-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
`static int`	`TYPEID` The type id of this class.
`static java.lang.String`	`TYPENAME` The constant class type identifier.

Method Summary
`void`	`addAddress(AlertAddress address)` Deprecated. 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.
`DeviceAddress`	`createDeviceAddress(java.lang.String name, DeliveryType deliveryType, java.lang.String address, int preference)` Creates a new Device Address with specified preference.
`Presence`	`createPresence()` Return a new Presence object.
`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.
`UserDevice`	`createUserDevice()` Creates a new user device.
`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[]`	`findAllAccessibleServices()` Find all Services accessible by the user.
`Service[]`	`findAsyncAccessibleServices()` Find all async Services accessible by the user.
`Service[]`	`findAsyncVisibleServices()` Find all visible async Services accessible by the user.
`Service[]`	`getAccessibleHomeFolderServices(Profile profile)` Get all valid and visible services in the user's root folder including the group-level accessible services.
`Service[]`	`getAccessibleHomeFolderServicesIncludeHidden(Profile profile)` Get all valid visible and invisible services in the user's root folder including the group-level accessible services.
`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 OracleAS Wireless from a voice device.
`AlertAddress[]`	`getAddresses()` Deprecated. Replaced by `getDeviceAddresses()`
`int`	`getAge()` Gets the age of the user.
`java.lang.String[]`	`getAllAsyncCustomizedCmd()` Get all Async command alias
`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`	`getAsyncCustomizedCmdValue(java.lang.String customizedName)` get Async command alias
`AuthLevel`	`getAuthLevel()` Gets the Auth Level, for the authentication level (High, Medium, Low) used to automatically set up the user's session.
`java.lang.String`	`getCountry()` Returns the country of this user.
`Presence`	`getCurrentPresence()` Return the current presence of the user.
`java.util.GregorianCalendar`	`getDateOfBirth()` Gets the date of birth of the user.
`AlertAddress`	`getDefaultAlertAddress()` Deprecated. Replaced by `getDefaultDeviceAddress()`
`DeviceAddress`	`getDefaultDeviceAddress()` Gets the default device address of this user.
`DeviceAddress`	`getDefaultDeviceAddress(DeliveryType deliveryType)` Returns the default device address for a delivery type
`LocationMark`	`getDefaultLocationMark()` Gets the default location mark of the user.
`Profile`	`getDefaultProfile()` Gets the default customization profile of the user.
`Profile`	`getDefaultProfile(boolean create)` Gets the default customization profile of the user.
`DeviceAddress[]`	`getDeviceAddresses()` Gets the list of user's device addresses
`DeviceAddress[]`	`getDeviceAddresses(DeliveryType deliveryType)` Returns device addresses of a particular delivery type.
`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`	`getDN()` Gets the Distinguished Name (DN) of the user, It is a mandatory atribute in Oracle Internet Directory (OID)
`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 mandatory 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
`LocationMark[]`	`getLocationMarks(int regionId)` Get the list of the user's region type LocationMarks which contains the region whose id is given.
`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.
`Presence[]`	`getPresences()` Return a list of available presences for 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.
`Service[]`	`getSortedHomeFolderServices(Profile profile)` Get all valid and visible services in the user's root folder including the group-level accessible services.
`java.util.TimeZone`	`getTimeZone()` Returns the time zone of the user.
`UserDevice`	`getUserDevice(java.lang.Long userDeviceId)` Loads a user device from given user device id.
`UserDevice[]`	`getUserDevices()` Gets the user's devices.
`UserDevice[]`	`getUserDevices(boolean orderByPreference)` Gets the user's devices.
`UserDevice[]`	`getUserDevicesOrderedByName()` Get all the user's devices ordered by name.
`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()` Deprecated. Checks if the user is administrator.
`boolean`	`isAnonymous()` Deprecated. Checks if the user is an anonymous user.
`boolean`	`isAutoLocate()` Deprecated. Shoud use LocationPrivacyDirective. AutoLocate value false is equivalent to LocationPrivacyManager.DIRECTIVE_NO_POSITION.
`boolean`	`isCallable(Service service)` Test if this user has permissions to call the service
`boolean`	`isDesigner()` Deprecated. Checks if the user is a service designer.
`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()` Deprecated. Checks if the user is helpdesk.
`DeviceAddress`	`lookupDeviceAddress(long id)` Lookup a Logical device by id.
`DeviceAddress`	`lookupDeviceAddress(java.lang.String name)` Lookup a device address by name.
`Presence`	`lookupPresence(long presenceID)` Return the presence having the specified ID.
`Presence`	`lookupPresence(java.lang.String name)` Return the presence having the specified 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)` Deprecated. Gets the service using a short name. First we look if the user have this shortname as a private shortname if so this Service is used. If no hit, next step is to find the shortname as a shortname in the users Group.
`UserDevice[]`	`lookupUserDevice(java.util.Hashtable caps)` Get the user's device(s) that matches the given capability.
`UserDevice`	`lookupUserDevice(java.lang.String name)` Lookup the user device with the matching name.
`UserDevice[]`	`lookupUserDevice(java.lang.String capability, java.lang.String value)` Get the user's device(s) that matches the given capability.
`UserDevice`	`lookupUserDeviceByUserAgent(java.lang.String userAgentStr)` Get the first user device that matches the given useragent.
`void`	`refreshFromOID()` refresh the wireless user info based on OID user attributes
`void`	`removeAddress(AlertAddress address)` Deprecated. 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`	`removeAsyncCustomizedCmd(java.lang.String customizedName)` remove Async command alias
`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`	`removePresence(Presence p)` Remove the specified presence.
`void`	`removeRole(Role role)` Remove a role from the list of user's roles.
`void`	`removeUserDevice(UserDevice ud)` Delete a user device.
`void`	`setAccountNumber(java.lang.String accountNumber)` Sets the account number for the user, that is used to identify the user accessing OracleAS Wireless from a voice device.
`void`	`setAdministrator(boolean administrator)` Deprecated. Sets the value that specifies whether the user is administrator.
`void`	`setAnonymous(boolean anonymous)` Deprecated. Sets the value that specifies whether the user is an anonymous user.
`void`	`setAsyncCustomizedCmd(java.lang.String customizedName, java.lang.String AsyncCmd)` set Async command alias
`void`	`setAuthLevel(AuthLevel authLevel)` Sets the Auth level for the user.
`void`	`setAutoLocate(boolean autoLocate)` Deprecated. Shoud use LocationPrivacyDirective. AutoLocate value false is equivalent to LocationPrivacyManager.DIRECTIVE_NO_POSITION, and true is equivalent to LocationPrivacyManager.DIRECTIVE_ALLOW_LCP.
`void`	`setCountry(java.lang.String country)` Sets the country of this user.
`void`	`setCurrentPresence(long presenceID)` Set the current presence of the user.
`void`	`setCurrentPresence(Presence p)` Set the current presence of the user.
`void`	`setDateOfBirth(java.util.GregorianCalendar dateOfBirth)` Sets the date of birth of the user
`void`	`setDefaultAlertAddress(AlertAddress alertAddress)` Deprecated. 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)` Deprecated. Sets the value that specifies whether the user is a service designer.
`void`	`setDeviceAddressPreference(int newPreference, DeviceAddress deviceAddress)` Sets the preference of device address to newPreference.
`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.

See Also:: Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:: Constant Field Values

Method Detail

getGlobalUID

public java.lang.String getGlobalUID()

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

Returns:: the global unique ID or null if not set.

getDN

public java.lang.String getDN()

Gets the Distinguished Name (DN) of the user, It is a mandatory atribute in Oracle Internet Directory (OID)

Returns:: the DN 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 OracleAS Wireless from a voice device.

Returns:: the account number.

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)

Sets the account number for the user, that is used to identify the user accessing OracleAS Wireless from a voice device.

Parameters:: accountNumber - tthe account number

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.

Parameters:: passwordHintAnswer - 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:: folder - 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.

findAllAccessibleServices

public Service[] findAllAccessibleServices()
                                    throws PanamaRuntimeException

Find all Services accessible by the user. This method flaten the services three structure.

Returns:: array of different Service leaf-class objects
Throws:: PanamaRuntimeException - if the Services cannot be found

findAsyncAccessibleServices

public Service[] findAsyncAccessibleServices()
                                      throws PanamaRuntimeException

Find all async Services accessible by the user. This method flaten the services three structure.

Returns:: array of different Service leaf-class objects
Throws:: PanamaRuntimeException - if the Services cannot be found

findAsyncVisibleServices

public Service[] findAsyncVisibleServices()

Find all visible async Services accessible by the user. This method flaten the services three structure.

Returns:: array of different Service leaf-class objects
Throws:: PanamaRuntimeException - if the Services cannot be found

isAdministrator

public boolean isAdministrator()

Deprecated. Checks if the user is administrator.

Returns:: true if this user is an Administrator.

isHelpDesk

public boolean isHelpDesk()

Deprecated. Checks if the user is helpdesk.

Returns:: true if this user is a helpdesk.

setAdministrator

public void setAdministrator(boolean administrator)

Deprecated. Sets the value that specifies whether the user is administrator.

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

isDesigner

public boolean isDesigner()

Deprecated. Checks if the user is a service designer.

Returns:: The designer property value.
See Also:: setDesigner(boolean)

setDesigner

public void setDesigner(boolean designer)

Deprecated. Sets the value that specifies whether the user is a service designer.

Parameters:: designer - The new value for the property.
See Also:: isDesigner()

isAnonymous

public boolean isAnonymous()

Deprecated. Checks if the user is an anonymous user.

Returns:: The anonymous property value.
See Also:: setAnonymous(boolean)

setAnonymous

public void setAnonymous(boolean anonymous)

Deprecated. Sets the value that specifies whether the user is an anonymous user.

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. Replaced by getDefaultDeviceAddress()

Returns:: the default AlertAddress or null if none.

setDefaultAlertAddress

public void setDefaultAlertAddress(AlertAddress alertAddress)

Deprecated. Replaced by setDefaultDeviceAddress(DeviceAddress)

Set the default AlertAddress for "asynchronous" jobs.

Parameters:: alertAddress - the agent.

getAddresses

public AlertAddress[] getAddresses()

Deprecated. Replaced by getDeviceAddresses()

Get the list of the user's alert addresses

Returns:: AlertAddress[] the addresses

addAddress

public void addAddress(AlertAddress address)

Deprecated. Replaced by addDeviceAddress(DeviceAddress)

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

Parameters:: address - the new address
See Also:: removeAddress(oracle.panama.model.AlertAddress)

removeAddress

public void removeAddress(AlertAddress address)

Deprecated. 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:: address - 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.

getDefaultDeviceAddress

public DeviceAddress getDefaultDeviceAddress(DeliveryType deliveryType)

Returns the default device address for a delivery type

Parameters:: deliveryType - the delivery type

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

getDeviceAddresses

public DeviceAddress[] getDeviceAddresses(DeliveryType deliveryType)

Returns device addresses of a particular delivery type. The returned array is ordered with most prefered device address at index 0.

Parameters:: deliveryType - the delivery type

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

createDeviceAddress

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

Creates a new Device Address with specified preference. The preference should be less than or equal to number of device addresses of the user

Parameters:: name - the not null name of the device address, mandatory; deliveryType - the delivery type, mandatory; address - the non null address, mandatory; preference - the device address preferebce
Returns:: the device address

setDeviceAddressPreference

public void setDeviceAddressPreference(int newPreference,
DeviceAddress deviceAddress)

Sets the preference of device address to newPreference. The preference should be less than number of device addresses of the user

Parameters:: newPreference - the new preference; deviceAddress - 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:: externalId - 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:: displayName - 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:: language - 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:: country - the country ISO code.
See Also:: getCountry()

lookupService

public Service lookupService(java.lang.String shortName)

Deprecated. Gets the service using a short name. First we look if the user have this shortname as a private shortname if so this Service is used. If no hit, next step is to find the shortname as a shortname in the users Group.

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

getLocationMarks

public LocationMark[] getLocationMarks(int regionId)

Get the list of the user's region type LocationMarks which contains the region whose id is given.

Parameters:: regionId - the id of a region
Returns:: LocationMark[] an array of LocationMark or null if no LocationMark contains the region whose id is given.

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()

Deprecated. Shoud use LocationPrivacyDirective. AutoLocate value false is equivalent to LocationPrivacyManager.DIRECTIVE_NO_POSITION.

Returns:: the autoLocate approximating a LocationPrivacyDirective.
See Also:: setAutoLocate(boolean)

setAutoLocate

public void setAutoLocate(boolean autoLocate)

Deprecated. Shoud use LocationPrivacyDirective. AutoLocate value false is equivalent to LocationPrivacyManager.DIRECTIVE_NO_POSITION, and true is equivalent to LocationPrivacyManager.DIRECTIVE_ALLOW_LCP.

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.

getDefaultProfile

public Profile getDefaultProfile(boolean create)

Gets the default customization profile of the user. If profile is null, it will create a profile if create=true.

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 <c0de>Service that we want to test
Returns:: true if the user can call the service false otherwise

setAuthLevel

public void setAuthLevel(AuthLevel authLevel)

Sets the Auth level for the user.

Parameters:: authLevel - level property value

getAuthLevel

public AuthLevel getAuthLevel()

Gets the Auth Level, for the authentication level (High, Medium, Low) used to automatically set up the user's session.

Returns:: the authentication Level of the user

getUserDevice

public UserDevice getUserDevice(java.lang.Long userDeviceId)

Loads a user device from given user device id.

Parameters:: userDeviceId - user device id.

createUserDevice

public UserDevice createUserDevice()

Creates a new user device.

Returns:: userDevice new user device created.

getUserDevices

public UserDevice[] getUserDevices()

Gets the user's devices.

Returns:: collection of user devices.

getUserDevices

public UserDevice[] getUserDevices(boolean orderByPreference)

Gets the user's devices.

Parameters:: orderByPreference - True if want to order by preference.
Returns:: collection of user devices ordered by preference if specified to be true..

getUserDevicesOrderedByName

public UserDevice[] getUserDevicesOrderedByName()

Get all the user's devices ordered by name. This method is only intended to be used by UI, because of the performance penalty here.

Returns:: The user's devices ordered by name.

lookupUserDevice

public UserDevice lookupUserDevice(java.lang.String name)

Lookup the user device with the matching name.

Returns:: the matching user device. Null is returned if not found.

lookupUserDevice

public UserDevice[] lookupUserDevice(java.util.Hashtable caps)

Get the user's device(s) that matches the given capability. Note: the capability entries in the Hashtable must have a name that matches that of one attribute, see DeliveryContextAttributeNames.java interface. And the value may be of String, or Boolean type right now. TBD: Allow multi-valued attribute.

lookupUserDevice

public UserDevice[] lookupUserDevice(java.lang.String capability,
                                     java.lang.String value)

Get the user's device(s) that matches the given capability.

See Also:: lookupUserDevice(Hashtable caps)

lookupUserDeviceByUserAgent

public UserDevice lookupUserDeviceByUserAgent(java.lang.String userAgentStr)

Get the first user device that matches the given useragent.

Returns:: The first user device that matches the given useragent.

removeUserDevice

public void removeUserDevice(UserDevice ud)

Delete a user device.

Parameters:: ud - the user device to be deleted.

setAsyncCustomizedCmd

public void setAsyncCustomizedCmd(java.lang.String customizedName,
                                  java.lang.String AsyncCmd)

set Async command alias

Parameters:: customizedName - Async command alias; AsyncCmd - An Async command string. It could be an Async short name. Or it could be the short name togetther with parameters

getAsyncCustomizedCmdValue

public java.lang.String getAsyncCustomizedCmdValue(java.lang.String customizedName)

get Async command alias

Parameters:: customizedName - Async command alias
Returns:: Async command alias

removeAsyncCustomizedCmd

public void removeAsyncCustomizedCmd(java.lang.String customizedName)

remove Async command alias

Parameters:: customizedName - Async command alias

getAllAsyncCustomizedCmd

public java.lang.String[] getAllAsyncCustomizedCmd()

Get all Async command alias

Returns:: all the Async command aliases associated with the user

getAccessibleHomeFolderServices

public Service[] getAccessibleHomeFolderServices(Profile profile)

Get all valid and visible services in the user's root folder including the group-level accessible services. The services are sorted by name, sequence number, or date.

Returns:: a Service[] of accessible services retrieving from user's home folder.

getSortedHomeFolderServices

public Service[] getSortedHomeFolderServices(Profile profile)

Get all valid and visible services in the user's root folder including the group-level accessible services. The services are sorted by name, sequence number, or date of creation as specified by the default sorting rule of the site (sorted in Name ascending order).

Returns:: a Service[] of accessible services retrieving from user's home folder.

getAccessibleHomeFolderServicesIncludeHidden

public Service[] getAccessibleHomeFolderServicesIncludeHidden(Profile profile)

Get all valid visible and invisible services in the user's root folder including the group-level accessible services. The services are sorted by name, sequence number, or date of creation as specified by the default sorting rule of the site (sorted in Name ascending order).

Returns:: a Service[] of accessible services retrieving from user's home folder.

getCurrentPresence

public Presence getCurrentPresence()

Return the current presence of the user.

Returns:: the current presence.

lookupPresence

public Presence lookupPresence(java.lang.String name)

Return the presence having the specified name.

Parameters:: name - the name of the presence
Returns:: the matching presence. Null is returned if not found.

lookupPresence

public Presence lookupPresence(long presenceID)

Return the presence having the specified ID.

Parameters:: presenceID - the ID of the presence
Returns:: the presence.

getPresences

public Presence[] getPresences()

Return a list of available presences for the user.

Returns:: the list of presences.

removePresence

public void removePresence(Presence p)

Remove the specified presence.

Parameters:: p - the presence to be deleted.

setCurrentPresence

public void setCurrentPresence(Presence p)

Set the current presence of the user.

Parameters:: p - the presence to be set as the user's current presence.

setCurrentPresence

public void setCurrentPresence(long presenceID)

Set the current presence of the user.

Parameters:: presenceID - the ID of the presence to be set as the user's current presence.

createPresence

public Presence createPresence()

Return a new Presence object.

Returns:: a new presence.

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Application Server Wireless Java API Reference
B10400-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.panama.model Interface User

TYPENAME

TYPEID

getGlobalUID

getDN

refreshFromOID

getAccountNumber

setAccountNumber

setPin

checkPin

setPassword

getPasswordHint

setPasswordHint

getPasswordHintAnswer

setPasswordHintAnswer

checkPassword

getGroups

setGroups

addGroup

removeGroup

removeAllGroups

getRoles

setRoles

addRole

removeRole

removeAllRoles

getHomeFolder

setHomeFolder

getOwnedUserServices

getAllUserServices

getValidUserServices

getAccessibleUserServices

findAllAccessibleServices

findAsyncAccessibleServices

findAsyncVisibleServices

isAdministrator

isHelpDesk

setAdministrator

isDesigner

setDesigner

isAnonymous

setAnonymous

isEnabled

setEnabled

getDefaultAlertAddress

setDefaultAlertAddress

getAddresses

addAddress

removeAddress

getDefaultDeviceAddress

getDefaultDeviceAddress

setDefaultDeviceAddress

getDeviceAddresses

getDeviceAddresses

removeDeviceAddress

addDeviceAddress

createDeviceAddress

createDeviceAddress

setDeviceAddressPreference

lookupDeviceAddress

lookupDeviceAddress

getExternalId

setExternalId

getDisplayName

setDisplayName

getLocale

setLocale

getLanguage

setLanguage

getCountry

setCountry

lookupService

getDefaultLocationMark

setDefaultLocationMark

getLocationMarks

getLocationMarks

addLocationMark

removeLocationMark

isAutoLocate

setAutoLocate

oracle.panama.model
Interface User