|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.Session
com.primavera.integration.client.LocalSession
public class LocalSession
Local Session, used to avoid the RMI layer when running in Local Mode.
Field Summary |
---|
Fields inherited from class com.primavera.integration.client.Session |
---|
DEFAULT_BIND_PARAM_LIMIT_ON_LOAD, DEFAULT_LOCAL_BATCH_SIZE, MAX_BIND_PARAM_LIMIT_ON_LOAD, MAX_BUSINESS_OBJECT_BATCH_SIZE, MIN_BIND_PARAM_LIMIT_ON_LOAD, MIN_BUSINESS_OBJECT_BATCH_SIZE |
Method Summary | |
---|---|
JobInfo[] |
getCurrentJobs()
Retrieves job information for any current asynchronous jobs of this user. |
static DatabaseInstance[] |
getDatabaseInstances(java.lang.String sUrl)
Retrieves all database instances supported by the server. |
DocumentManager |
getDocumentManager()
Deprecated. As of release 6.2, this method is no longer supported in the API. |
com.primavera.integration.collab.initiation.InitiationManager |
getInitiationManager()
Deprecated. As of release 6.2, this method is no longer supported in the API. |
ObjectId |
getUserObjectId()
Gets the user id of the current user. |
ObjectId |
getUSessionId()
Returns an ObjectId representation of the usession id |
boolean |
isValid()
Verifies if the session is valid. |
java.sql.Timestamp |
loadSafetyDate()
Loads the safety date from the database. |
static Session |
login(java.lang.String sUrl,
java.lang.String sDbId,
java.lang.String sUserName,
java.lang.String sPassword)
Logs in and obtains a Session object. |
void |
logout()
Notifies the server that this session is no longer needed and release any resource allocated for this session. |
Methods inherited from class com.primavera.integration.client.Session |
---|
getBatchFailOnFirstFlag, getBindParameterLimitOnLoad, getBusinessObjectBatchSize, getDatabaseEncoding, getDatabaseInstanceId, getDatabaseName, getDatabaseType, getDatabaseUrl, getEnterpriseLoadManager, getGlobalObjectManager, getJobManager, getUserName, getXMLExporter, getXMLImporter, isLocalModeAvailable, isRemoteModeAvailable, setBatchFailOnFirstFlag, setBindParameterLimitOnLoad, setBusinessObjectBatchSize |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DatabaseInstance[] getDatabaseInstances(java.lang.String sUrl) throws ServerException
sUrl
- identify the location of the server
ServerException
- if a problem occurred on the server-sidepublic static Session login(java.lang.String sUrl, java.lang.String sDbId, java.lang.String sUserName, java.lang.String sPassword) throws ServerException
sUrl
- the location of the serversDbId
- the database instance idsUserName
- the user namesPassword
- the password
ServerException
- if a problem occurred on the server-sidepublic void logout()
logout
in class Session
public boolean isValid()
isValid
in class Session
public ObjectId getUserObjectId() throws ServerException
getUserObjectId
in class Session
ServerException
- if a problem occurred on the server-sidepublic ObjectId getUSessionId() throws ServerException
ObjectId
representation of the usession id
getUSessionId
in class Session
ServerException
- if a problem occurred on the server-sidepublic JobInfo[] getCurrentJobs() throws ServerException
ServerException
- if a problem occurred on the server-side@Deprecated public DocumentManager getDocumentManager()
Session
getDocumentManager
in class Session
@Deprecated public com.primavera.integration.collab.initiation.InitiationManager getInitiationManager()
Session
getInitiationManager
in class Session
public java.sql.Timestamp loadSafetyDate() throws ServerException
Session
loadSafetyDate
in class Session
ServerException
- when a Server exception occurs
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |