com.buildforge.services.common.dbo
Class SessionDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.SessionDBO

public class SessionDBO
extends DBObject

Database information representing a user's login session. This information is used for licensing purposes and for tracking a user's state information. Normally, this information is not access directly by an end user, except possibly by the Root User for the purpose of forcefully closing a user's session.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
SessionDBO()
           
 
Method Summary
 DBObject fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 int getCreated()
           
 int getExpires()
           
 int getModified()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getUid()
           
 int getUserId()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setCreated(int created)
           
 void setExpires(int expires)
           
 void setModified(int modified)
           
 void setUid(java.lang.String uid)
           
 void setUserId(int userId)
           
 java.lang.Object[] toArray()
          Serializes this database object as an array of objects.
 java.lang.String toString()
           
 
Methods inherited from class com.buildforge.services.common.dbo.DBObject
badId, badName, checkDead, checkLive, collision, collision
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values
Constructor Detail

SessionDBO

public SessionDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

getCreated

public int getCreated()

getExpires

public int getExpires()

getModified

public int getModified()

getUid

public java.lang.String getUid()

getUserId

public int getUserId()

setCreated

public void setCreated(int created)

setExpires

public void setExpires(int expires)

setModified

public void setModified(int modified)

setUid

public void setUid(java.lang.String uid)

setUserId

public void setUserId(int userId)

fromArray

public DBObject fromArray(java.lang.Object[] data)
                   throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
APIException - if there is something wrong with the serialized data that interferes with the reconstruction of the object. The most obvious reason for this would be if the serialized array contains the wrong number of fields or otherwise does not match the serialized form for this type of database object.

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object