Process Class Relationships

filenet.vw.api
Class VWInjectSessionInfo

filenet.vw.api.VWInjectSessionInfo
All Implemented Interfaces:
java.io.Serializable

public final class VWInjectSessionInfo
implements java.io.Serializable

Use this class to get information about an inject session. An inject session injects objects into the workflow system through the VWNewWorkObject class.

The user specifies the inject session and its name, choosing one of the following:

See Also:
VWNewWorkObject, Serialized Form

Method Summary
static boolean DeleteInjectSession(VWRoster server, java.lang.String sessionName)
          Deletes an inject session.
static VWInjectSessionInfo GetInjectSessionInfo(VWRoster server, java.lang.String sessionName, boolean nextName)
          Gets status information on the specified inject session.
 java.util.Date getLastUpdateTime()
          Gets the time when the system last used the inject session.
 java.lang.String getSessionName()
          Gets the session name.
 java.lang.String getSessionStatus()
          Get session status.
 java.lang.String toString()
          Get the string version of the values of the sessionName, sessionStatus, and lastUpdateTime of the inject session.
 

Method Detail

DeleteInjectSession

public static boolean DeleteInjectSession(VWRoster server,
                                          java.lang.String sessionName)
                                   throws VWException
Deletes an inject session.
Parameters:
server - A roster object containing the name of the server that started the inject session after a call to the VWNewWorkObject.SaveMany() method.
sessionName - The session name.
Returns:
A Boolean value. The method returns true if the inject session was successfully deleted; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if the inject session could not be deleted.

GetInjectSessionInfo

public static VWInjectSessionInfo GetInjectSessionInfo(VWRoster server,
                                                       java.lang.String sessionName,
                                                       boolean nextName)
                                                throws VWException
Gets status information on the specified inject session.
Parameters:
server - A roster object containing the name of the roster on the server used to inject the session. For the Web Services API, this parameter is the entry for the VWNewWorkObject.SaveMany() method serverToUse parameter.
sessionName - The user-assigned name for the inject session. For the Web Services API, this parameter is the entry the VWNewWorkObject.SaveMany() method sessionName parameter.
nextName - A Boolean value. Specify true to retrieve information about the next session (after the session defined in the sessionName parameter); specify false to retrieve the information defined for this session only (in the sessionName parameter).
Returns:
An inject session object - if the nextName parameter value is true. If the system cannot find the session, the method returns an empty string.The method returns the following information if the session name is:

  • Valid: information on the next logical session, immediately after the current session.
  • Invalid: information about the current session. The name of the current session is logically greater than an invalid name.
  • NULL: information about the first logical session in the database.

Throws:
VWException - The method throws an exception if the program cannot obtain and report the status information for the specified inject session.
See Also:
VWNewWorkObject

getSessionName

public java.lang.String getSessionName()
Gets the session name.
Returns:
A string value containing the session name. If the system cannot find the session, the method returns an empty string.

getSessionStatus

public java.lang.String getSessionStatus()
Get session status.
Returns:
A string value containing the session status information. If the system cannot find the session, the method returns an empty string.

getLastUpdateTime

public java.util.Date getLastUpdateTime()
Gets the time when the system last used the inject session.
Returns:
A Time value containing the time the system last used the inject session.

toString

public java.lang.String toString()
Get the string version of the values of the sessionName, sessionStatus, and lastUpdateTime of the inject session.
Returns:
String that contains the session name, session status, and time of the inject session.
See Also:
VWNewWorkObject.SaveMany(VWNewWorkObject[], VWRoster, String, String)

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.