|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientAPIContext
Interface that defines the context for QVCS-Enterprise Client API requests. The implementation of this interface will likely be a java bean style class. The methods defined here define the accessor methods needed.
Method Summary | |
---|---|
java.lang.String |
getAppendedPath()
Get the appendedPath. |
java.lang.String |
getFileName()
Get the file name. |
java.lang.String |
getPassword()
Get the password. |
java.lang.Integer |
getPort()
Get the port number where the QVCS-Enterprise server is listening for connections from QVCS-Enterprise clients. |
boolean |
getPreserveStateFlag()
Get the preserveState flag. |
java.lang.String |
getProjectName()
Get the project name. |
boolean |
getRecurseFlag()
Get the recurse flag. |
java.lang.String |
getServerIPAddress()
Get the QVCS-Enterprise server IP address. |
java.lang.String |
getUserName()
Get the user name. |
java.lang.String |
getViewName()
Get the view name. |
void |
setAppendedPath(java.lang.String appendedPath)
Set the appended path. |
void |
setFileName(java.lang.String fileName)
Set the file name. |
void |
setPassword(java.lang.String password)
Set the password. |
void |
setPort(java.lang.Integer port)
Set the port number that the QVCS-Enterprise client API will use when attempting to establish a connection to the QVCS-Enterprise server. |
void |
setPreserveStateFlag(boolean flag)
Set the preserveState flag. |
void |
setProjectName(java.lang.String projectName)
Set the project name. |
void |
setRecurseFlag(boolean flag)
Set the recurse flag. |
void |
setServerIPAddress(java.lang.String serverIPAddress)
Set the QVCS-Enterprise server IP address. |
void |
setUserName(java.lang.String userName)
Set the user name. |
void |
setViewName(java.lang.String viewName)
Set the view name. |
Method Detail |
---|
java.lang.String getUserName()
void setUserName(java.lang.String userName)
userName
- the user name used to login to the QVCS-Enterprise server.java.lang.String getPassword()
void setPassword(java.lang.String password)
password
- the password.java.lang.String getServerIPAddress()
void setServerIPAddress(java.lang.String serverIPAddress)
serverIPAddress
- the server IP address.java.lang.Integer getPort()
void setPort(java.lang.Integer port)
port
- the port number used by the QVCS-Enterprise server to listen for client connections.java.lang.String getProjectName()
void setProjectName(java.lang.String projectName)
projectName
- the name of the QVCS-Enterprise project that you are interested in.java.lang.String getViewName()
void setViewName(java.lang.String viewName)
viewName
- the view that you are interested in.java.lang.String getAppendedPath()
void setAppendedPath(java.lang.String appendedPath)
appendedPath
- the directory within the view that you are interested in.java.lang.String getFileName()
void setFileName(java.lang.String fileName)
fileName
- the file name.boolean getRecurseFlag()
void setRecurseFlag(boolean flag)
flag
- the value for the recurse flag.boolean getPreserveStateFlag()
Get the preserveState flag. This flag indicates whether calls through the client API are stateless (the default), or stateful. If the calls are stateless, then no state is preserved from one call on the ClientAPI to the next: the client logs in to the server for each call, and logs out from the server when the call is completed. If this flag is set to preserve state (true), then the client api will preserve state across calls when it can. Performance will be better if this flag is set to true. By default, its value is false.
Some calls will force the client to disconnect from the server and state will be discarded. For example, if the preserve state
is set to true, and the client performs a getProjectList
call followed by a setServerIPAddress
call on this class, then state will be
lost after the setServerIPAddress call since the server end point has now changed.
void setPreserveStateFlag(boolean flag)
getPreserveStateFlag
for a description of how this flag works.
You should set this flag before beginning method calls on the ClientAPI.
flag
- the new value for the preserveState flag.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |