|
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 |
java.lang.Object | +--oracle.panama.presence.model.PresenceServer
The PresenceServer class. This class provides the API to lookup, modify, add, remove presence information and set current presence for users. This class is used by calling the getInstance() method, which will return the PresenceServer instance that the caller can use.
Constructor Summary | |
PresenceServer() |
Method Summary | |
abstract Presence |
createNewPresence(long userID) Return a new Presence object. |
abstract Presence |
getCurrentPresence(long userID) Return the current presence of the specified user. |
abstract Presence |
getCurrentPresence(java.lang.String guid) Return the current presence of the specified user. |
abstract DeviceAddress[] |
getDeviceAddresses(long userID) Return a list of device addresses in the current presence profile of the specified user. |
abstract DeviceAddress[] |
getDeviceAddresses(java.lang.String guid) Return a list of device addresses in the current presence profile of the specified user. |
static PresenceServer |
getInstance() Return the single instance of the PresenceServer. |
abstract Presence |
getPresence(long presenceID) Deprecated. Replaced by getPresence(long, long). |
abstract Presence |
getPresence(long presenceID, long userID) Return the presence having the specified ID |
abstract Presence |
getPresence(java.lang.String presenceName, long userID) Return the presence having the specified name (for the given user). |
abstract Presence[] |
listPresences(long userID) Return a list of available presences for the specified user. |
abstract Presence[] |
listPresences(java.lang.String guid) Return a list of available presences for the specified user. |
abstract void |
removePresence(long presenceID) Remove the specified presence. |
abstract void |
removePresence(Presence presence) Remove the specified presence. |
abstract void |
savePresence(Presence presence) Deprecated. Use Model Factory to save. For example, MetaLocator.getInstance().getModelFactory().save(); |
abstract void |
setCurrentPresence(long presenceID, long userID) Set the current presence of the specified user. |
abstract void |
setCurrentPresence(Presence presence, long userID) Set the current presence of the specified user. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PresenceServer()
Method Detail |
public abstract Presence getCurrentPresence(long userID)
userID
- the user's ID.public abstract Presence getCurrentPresence(java.lang.String guid) throws PresenceException
guid
- the user's global ID.PresenceException
public abstract void setCurrentPresence(Presence presence, long userID) throws PresenceException
presence
- the Presence object to be set as current.userID
- the ID of the user whose current presence is to be set. Note that the presence must already belong to the user before it is set as current.PresenceException
public abstract void setCurrentPresence(long presenceID, long userID) throws PresenceException
presenceID
- the ID of the presence to be set as current.userID
- the ID of the user whose current presence is to be set. Note that the presence must already belong to the user before it is set as current.PresenceException
public abstract Presence getPresence(long presenceID)
presenceID
- the precense's ID.getPresence(long, long)
public abstract Presence getPresence(long presenceID, long userID)
presenceID
- the precense's ID.userID
- the ID of the user having this presence.public abstract Presence getPresence(java.lang.String presenceName, long userID)
presenceName
- the precense's name.userID
- the user's ID.public abstract Presence[] listPresences(long userID)
userID
- the user's ID.public abstract Presence[] listPresences(java.lang.String guid) throws PresenceException
guid
- the user's global ID.PresenceException
public abstract Presence createNewPresence(long userID)
userID
- the user's ID.public abstract void savePresence(Presence presence) throws PresenceException
presence
- the Presence object to be persisted.PresenceException
ModelFactory.save()
, MetaLocator
public abstract void removePresence(Presence presence) throws PresenceException
presence
- the presence to be removed.PresenceException
public abstract void removePresence(long presenceID) throws PresenceException
presenceID
- the ID of the presence to be removed.PresenceException
public abstract DeviceAddress[] getDeviceAddresses(long userID)
userID
- the user's ID.oracle.panama.model.DeviceAddress.
public abstract DeviceAddress[] getDeviceAddresses(java.lang.String guid) throws PresenceException
guid
- the user's global ID.PresenceException
oracle.panama.model.DeviceAddress.
public static PresenceServer getInstance()
|
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 |