|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWSession
Use this class to establish a session and log onto a Process Engine. Once you have a session object, you can do the following:
fetchRosterNames(boolean)
or fetchQueueNames(int)
methods.
If you are creating a session for FileNet Web Services or Open Client, use
the constructor that has no arguments and call the logon method
first.
If you are developing for FileNet Web Services or Open Client, to logon use the
JiGlue COM Bridge (JiGlue.Util) to instantiate a VWSession() object;
then invoke the VWSession.logon method with your
logon(String, String, String)
parameters. For example, the
following VB code will logon to a Process Engine Session:
set objJiGlue = CreateObject("JiGlue.Util") set session = objJiGlue.newInstance("filenet.vw.api.VWSession") session.logon "SysAdmin","SysAdmin","rmi://" & web_server_name & "/" & router_nameIf you wish to use the Application Engine .asp files with this session, call the
setProductId(int)
method after logging on.
WARNING: If the same or a duplicate VWSession object is used more than one time concurrently, a Process Services error (SAS session is already open) will result.
recoverUser( String, String[] )
,
VWRoster
,
VWQueue
, Serialized FormField Summary | |
static int |
ATTRIBUTES_REGION
Value of 2. Indicates region-specific attributes, for use with the fetchAttributes(int) method. |
static int |
ATTRIBUTES_SYSTEM
Value of 1. Indicates system-wide attributes, for use with the fetchAttributes(int) method. |
static int |
DATABASE_ORACLE
Value of 1. Indicates an Oracle Database. |
static int |
DATABASE_SQL2000
Value of 2. Indicates a SQL2000 Database. |
static int |
DS_TYPE_LDAP
Value of 1, representing a Lightweight Directory Access Protocol (LDAP) database security type. |
static int |
DS_TYPE_SEC
Value of 0, representing a FileNet database security type. |
static int |
PRODUCT_BPS
Deprecated. Replaced by use of setDefaultWebApplication(int) |
static int |
PRODUCT_CUSTOM
Deprecated. Replaced by use of setDefaultWebApplication(int) |
static int |
PRODUCT_OPEN_CLIENT
Deprecated. Replaced by use of setDefaultWebApplication(int) |
static int |
PRODUCT_PW
Deprecated. Replaced by use of setDefaultWebApplication(int) |
static int |
QUEUE_IGNORE_SECURITY
Value of 16. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of queues to which the user has no access. |
static int |
QUEUE_PROCESS
Value of 1. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each process queue (a queue that holds objects for an external workflow to process). |
static int |
QUEUE_SYSTEM
Value of 4. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each system queue (a queue that the system configures). |
static int |
QUEUE_USER_CENTRIC
Value of 2. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each user queue (the individual queue of a workflow user, similar to a inbox for the user). |
static int |
QUEUE_USER_CENTRIC_FOR_USER_ONLY
Value of 32. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of the user-centric queue associated with the user information. |
static int |
SEARCH_TYPE_CONTAINS
Value of 4, indicating a pattern search would match when all of the characters in the pattern match, in order, to a corresponding series of characters in the name being compared, and that the name may contain additional alphanumeric characters before or after the matching series of characters. |
static int |
SEARCH_TYPE_CUSTOM
Value of 1, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding characters in the name being compared, and that the name does not contain any characters before or after the matching characters. |
static int |
SEARCH_TYPE_NONE
Value of 0, indicating a pattern search would match all user names and ignore the searchPattern string. |
static int |
SEARCH_TYPE_PREFIX_MATCH
Value of 2, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding beginning series of characters in the name being compared, and that the name may contain additional alphanumeric characters after the matching series of characters. |
static int |
SEARCH_TYPE_SUFFIX_MATCH
Value of 3, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding ending series of characters in the name being compared, and that the name may contain additional alphanumeric characters before the matching series of characters. |
static int |
SORT_TYPE_ASCENDING
Value of 1, indicating an ascending sort is to be performed. |
static int |
SORT_TYPE_DESCENDING
Value of 2, indicating a descending sort is to be performed. |
static int |
SORT_TYPE_NONE
Value of 0, indicating no sorting is to be performed. |
static int |
WEBAPP_CUSTOM
Value of 100. Indicates the web application is for custom use. |
static int |
WEBAPP_NONE
Value of 0. Indicates the web application is not set. |
static int |
WEBAPP_OPEN_CLIENT
Value of 3. Indicates the web application is Open Client. |
static int |
WEBAPP_WEB_WORKFLO
Value of 2. Indicates the web application is FileNet Web Services. |
static int |
WEBAPP_WORKPLACE
Value of 1. Indicates the web application is Application Engine. |
Constructor Summary | |
VWSession()
Use this constructor with FileNet Web Services or Open Client. |
|
VWSession(java.lang.String user,
java.lang.String password,
java.lang.String router_URL)
Use this constructor to establish a session. |
Method Summary | |
boolean |
checkSystemWideFlagSetting(int flagOptions)
Checks the system wide flag settings given the VWSystemAdministration System wide flag option. |
boolean |
checkWorkflowIdentifier(java.lang.String workflowIdentifier)
Determines whether or not a workflow is on the Process Engine, given an associated workflow version ID. |
int |
convertClassNameToId(java.lang.String aClassName,
boolean aQueueClassType)
Converts a roster or queue name to a class ID. |
java.lang.String |
convertIdToClassName(int aClassId,
boolean aQueueClassType)
Converts a class ID to a roster name or queue name. |
java.lang.String |
convertIdToUserName(int aUserId)
Converts a user ID to a user name. |
int |
convertUserNameToId(java.lang.String aUserName)
Converts a user name in three-part format (name:domain:organization)to user ID. |
VWCreateLiveWOResult[] |
createLiveWorkObject(java.lang.String[] fieldNames,
java.lang.Object[] fieldValues,
java.lang.String workflowIdentifier,
int numberToCreate)
Creates (initializes, saves, and dispatches) work items from a transferred workflow definition, specified by its workflow identifier. Supports multiple work classes on one roster. |
VWNewWorkObject |
createNewWorkObject(java.lang.String workClassName)
Deprecated. Replaced by createLiveWorkObject(String[], Object[], String, int) |
VWStepElement |
createWorkflow(java.lang.String workflowIdentifier)
Launches a workflow defined by a transferred workflow definition, as specified by a workflow identifier version String derived from a VWTransferResult object
or a workflow
definition name (work class name). |
VWAttributeInfo |
fetchAttributes(int nFlag)
Fetches system-wide or region-specific attribute information from the Process Engine for the current logged-on session. |
VWUserInfo |
fetchCurrentUserInfo()
Gets information about the user logged on to this session. |
VWLog |
fetchEventLog(java.lang.String eventLogName)
Retrieves an event log, given an associated event log name. |
java.lang.String[] |
fetchEventLogNames()
Retrieves the name of every event log in the Process Engine system. |
boolean[] |
fetchIsGroup(java.lang.String[] names)
Determines whether or not names passed in are groups. |
VWStepProcessorInfo |
fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
Retrieves a launch step processor, given an associated workflow definition ID. |
VWProcess |
fetchProcess(int workSpaceId,
int workClassId,
java.lang.String workflowNumber)
Retrieves the workflow process containing this work object. |
java.lang.String[] |
fetchQueueNames(int fetchFlag)
Retrieves the names of every work queue accessible through the session, within the queue type scope specified. |
java.lang.String[] |
fetchRosterNames(boolean ignoreSecurity)
Retrieves the name of every roster in the system. |
VWStepProcessorInfo |
fetchStepProcessorInfo(java.lang.String processorIdentifier)
Retrieves a step processor object defined for the current session and workflow definition, given the step processor ID. |
VWStepProcessorInfo[] |
fetchStepProcessors(int processorFlag)
Retrieves a list of step processor objects defined for the current session and workflow definition. |
VWSystemAdministration |
fetchSystemAdministration()
Gets system administration information for the Process Engine. |
VWSystemConfiguration |
fetchSystemConfiguration()
Gets system configuration information for a system. |
VWSecurityList |
fetchUserGroups(int maxBufferSize)
Gets group names for the Process Engine. |
VWUserInfo |
fetchUserInfo(java.lang.String theName)
Gets general user information about a specified user. |
VWSecurityList |
fetchUsers(int maxBufferSize,
boolean includeGroups)
Fetches a collection of all user names defined on the Process Engine. |
java.lang.String[] |
fetchWorkClassNames(boolean ignoreSecurity)
Retrieves the name of every work class in the system. |
VWWorkflowDefinition |
fetchWorkflowDefinition(int workSpaceId,
java.lang.String workflowIdentifier)
Deprecated. Replaced by fetchWorkflowDefinition(int,String, boolean)
which can handle a workflow definition that
references a work class from a previous
version of Process that was known as Panagon Visual
WorkFlo. It also can represent a workflow definition that
explicitly incorporates default terminate or malfunction maps. |
VWWorkflowDefinition |
fetchWorkflowDefinition(int workSpaceId,
java.lang.String workflowIdentifier,
boolean convert)
Fetches a workflow definition, given the workspace ID and the work class name or the version String. |
VWWorkflowSignature |
fetchWorkflowSignature(java.lang.String workflowIdentifier)
Returns the workflow signature, given an associated work class name or workflow version. |
VWSecurityList |
findGroups(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all group names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments. |
VWSecurityList |
findUsers(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all user names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments. |
static java.lang.String[] |
getActiveRouters(java.lang.String serverURL)
For the Application Engine only, this method lists the names of the routers configured on the Process Engine's server. |
java.lang.String |
getCurrentVersion()
Gets the current version of the Process Engine API. |
int |
getDatabaseType()
Gets the database configuration type for the workflow database. |
static java.lang.String |
getDefaultRouter(java.lang.String serverURL)
For the Application Engine only, this method determines the name of the default router configured on the Process Engine's server. |
java.lang.String |
getDefaultSecurityDomain()
Returns the name of the default security domain. |
int |
getDefaultWebApplication()
Gets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region. |
int |
getIsolatedRegion()
Gets an integer that specifies the isolated region for the current session. |
VWQueue |
getQueue(java.lang.String queueName)
Gets a queue object for the specified queue. |
java.lang.String[] |
getQueueNames(boolean includeSystem)
Deprecated. Replaced by fetchQueueNames(int) |
VWRoster |
getRoster(java.lang.String rosterName)
Gets a VWRoster object that represents the specified workflow roster. A workflow roster is a collection of records that represents the work objects that an associated work class instantiates. |
java.lang.String[] |
getRosterNames()
Deprecated. Replaced by fetchQueueNames(int) |
java.lang.String |
getRouterURL()
Gets the service name in String format, as follows: <:host name>:<port>/<router name> |
int |
getSecurityDatabaseType()
Returns the type of security database. |
java.lang.String |
getServerName()
Returns the name of the Process Engine's server for the current session. |
java.lang.String |
getToken()
Gets a token from the user logon, which a shared logon may use. |
java.lang.String[] |
getUserNames()
Deprecated. Replaced by fetchUsers(int, boolean) |
boolean |
isLoggedOn()
Checks whether this session is currently logged on or not. |
boolean |
isMemberOfGroup(java.lang.String groupName)
Determines whether or not the logged on user is a member of a specific group. |
void |
logoff()
Ends the session with the Process Engine and frees all resources. |
void |
logon(java.lang.String user,
java.lang.String password,
java.lang.String router_URL)
Logs onto an existing session. |
void |
logonWithToken(java.lang.String theToken,
java.lang.String router_URL)
For FileNet Web Services and Open Client only, this method can establish a shared logon session. |
boolean |
recoverUser(java.lang.String userName,
java.lang.String[] queueNames)
Recovers a user, given a list of queue names like the list produced by fetchQueueNames(int) . |
void |
setAuditState(java.lang.String fileName,
java.lang.Integer[] options)
Deprecated. Replaced by inserting a copy of the fnlogging.properties file in the <JRE>\lib directory. Edit this file to view or change logging properties. For detail information on the components of the fnlogging.properties file, see the Sun Javadoc documentation on the members of the java.util.logging class. |
void |
setDefaultWebApplication(int theWebApplicationId)
Sets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region. |
void |
setProductId(int theProductId)
Deprecated. Replaced by setDefaultWebApplication(int) |
java.lang.String |
toString()
Gets the router name and isolated region in String format, as entered by the user. |
VWTransferResult |
transfer(VWWorkflowDefinition theWorkflow,
java.lang.String theWFDocKey,
boolean theLinked,
boolean theMakeNewWorkSpace)
Transfers the workflow definition object, saving it on the Process Engine.The work class name saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method of of the input
workflow definition. |
void |
updateAPIUserCache()
Caches user names for methods convertIdtoUserName, convertUserNametoId and getUserNames, for performance enhancement. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int QUEUE_PROCESS
public static final int QUEUE_USER_CENTRIC
public static final int QUEUE_SYSTEM
public static final int QUEUE_IGNORE_SECURITY
public static final int QUEUE_USER_CENTRIC_FOR_USER_ONLY
public static final int PRODUCT_PW
setDefaultWebApplication(int)
public static final int PRODUCT_BPS
setDefaultWebApplication(int)
public static final int PRODUCT_OPEN_CLIENT
setDefaultWebApplication(int)
public static final int PRODUCT_CUSTOM
setDefaultWebApplication(int)
public static final int WEBAPP_NONE
public static final int WEBAPP_WORKPLACE
public static final int WEBAPP_WEB_WORKFLO
public static final int WEBAPP_OPEN_CLIENT
public static final int WEBAPP_CUSTOM
public static final int DATABASE_ORACLE
public static final int DATABASE_SQL2000
public static final int ATTRIBUTES_SYSTEM
fetchAttributes(int)
method.public static final int ATTRIBUTES_REGION
fetchAttributes(int)
method.public static final int DS_TYPE_SEC
public static final int DS_TYPE_LDAP
public static final int SEARCH_TYPE_NONE
public static final int SEARCH_TYPE_CUSTOM
public static final int SEARCH_TYPE_PREFIX_MATCH
public static final int SEARCH_TYPE_SUFFIX_MATCH
public static final int SEARCH_TYPE_CONTAINS
public static final int SORT_TYPE_NONE
public static final int SORT_TYPE_ASCENDING
public static final int SORT_TYPE_DESCENDING
Constructor Detail |
public VWSession()
logon(String, String, String)
method.
Example:
set objJiGlue = CreateObject("JiGlue.Util") set session = objJiGlue.newInstance("filenet.vw.api.VWSession") session.logon "SysAdmin","SysAdmin","rmi://" & web_server_name & "/" & router_name
For Java environments, instantiate VWSession and logon in a single
call, using VWSession(String, String, String)
; this
is simpler and more efficient.
public VWSession(java.lang.String user, java.lang.String password, java.lang.String router_URL) throws VWException
Example:
String web_server_name "MyWebServer"; String router_name "MyRouter"; VWSession ssnX = new VWSession("MyUser","MyUserPW", "rmi://" & web_server_name & "/" & router_name);
user
- The Process Engine user namepassword
- The user passwordrouterURL
- The URL of the web
server router, including the RMI protocolVWException
- Causes include the specified logon
already existingMethod Detail |
public void logon(java.lang.String user, java.lang.String password, java.lang.String router_URL) throws VWException
Example:
String web_server_name "MyWebServer"; String router_name "MyRouter"; VWSession ssnX = new VWSession(); ssnX.logon(("MyUser","MyUserPW", "rmi://" & web_server_name & "/" & router_name);
user
- The Process Engine user namepassword
- The passwordrouterURL
- The URL of the web
server router, including the RMI protocol.VWException
- Causes include the specified logon
already existspublic void logonWithToken(java.lang.String theToken, java.lang.String router_URL) throws VWException
theToken
- The Process token.routerURL
- The URL of the web server router, including the
RMI protocol.VWException
- Causes include invalid arguments, like
timed-out and invalid tokens.getToken()
public VWRoster getRoster(java.lang.String rosterName) throws VWException
Use the fetchRosterNames(boolean)
method to get a list
of workflow roster names.
In multi-server environments, if the roster is on an additional server that has not been accessed, the first method executed on the roster automatically logs the user onto the additional server. If the additional server was previously accessed during the session, the logon information is shared.
rosterName
- The name of the workflow rosterVWException
- public VWQueue getQueue(java.lang.String queueName) throws VWException
Use the fetchQueueNames(int)
method to get a list of
queue names.
In multi-server environments, if the queue is on a server that has not been accessed, the first method call performed on the queue automatically logs the user onto the additional server. If the additional server was previouly accessed during the session, the logon information is shared.
queueName
- A queue nameVWException
- public boolean isLoggedOn()
true
if this session is currently logged on, or false
if
this session is not logged on.public void logoff() throws VWException
When calling this method, keep the following guidelines in mind:
VWException
- Thrown if the method cannot end the
session with the Process Engine and free all resources.public java.lang.String[] getQueueNames(boolean includeSystem) throws VWException
fetchQueueNames(int)
getQueue(String)
method.includeSystem
- true
causes the execustion to
include the
name of every system work queue in the returned String array;
otherwise specify false
.VWException
- Causes include
communications, server and connection problems.public java.lang.String[] fetchQueueNames(int fetchFlag) throws VWException
getQueue(String)
method.fetchFlag
- An integer value that represents the queue type
you wish to return. Set this value to the bitwise OR
of more than one of the queue process types to get the names
of more than one type of queue process.
Values for the QUEUE_PROCESS types are as follows:
Example:
// Fetch a list of queue names for Process queues and System Queues, // whether this user has access privilege to the queues or not: int myQueueFlags = (QUEUE_PROCESS | QUEUE_SYSTEM | QUEUE_IGNORE_SECURITY); String[] QueueNames = null; QueueNames = MySession.fetchQueueNames(myQueueFlags);
VWException
- Causes include
communications, server and connection problems.QUEUE_PROCESS
public java.lang.String[] getRosterNames() throws VWException
fetchQueueNames(int)
getRoster(String)
.VWException
- Causes include
communications, server and connection problems.public java.lang.String[] fetchRosterNames(boolean ignoreSecurity) throws VWException
ignoreSecurity
- true
cause execution to enable
returning the names of rosters which this user is not
authorized to access; false
causes this method
to return only
names of rosters which this user is authorized to access.VWException
- Causes include
communications, server and connection problems.public java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity) throws VWException
ignoreSecurity
- true
cause execution to enable
returning the names of work classes which this user is not
authorized to access; false
causes this method to return only
names of work classes which this user is authorized to access.VWException
- Type of causes include
communications, server and connection problems.public java.lang.String getCurrentVersion()
public java.lang.String[] getUserNames() throws VWException
fetchUsers(int, boolean)
VWException
- Causes include when the user is not
authorized to call this method, or when the number of names
exceeds two million (2,000,000).public int convertUserNameToId(java.lang.String aUserName) throws VWException
aUserName
- The user name in a
three-part format as follows:
VWException
- Causes include:
convertIdToUserName(int)
public java.lang.String convertIdToUserName(int aUserId) throws VWException
aUserId
- The user ID used to retrieve the user nameVWException
- Causes include:
convertUserNameToId(java.lang.String)
public void updateAPIUserCache() throws VWException
VWException
- Causes include:
convertUserNameToId(java.lang.String)
,
convertIdToUserName(int)
,
getUserNames()
public int convertClassNameToId(java.lang.String aClassName, boolean aQueueClassType) throws VWException
aClassName
- The specified name of the workflow roster or
queue to convertaQueueClassType
- true
to convert the name
of a workflow queue;
false
to convert the name of a workflow roster.VWException
- Causes include user lack of administrative
privilege to call this method.public java.lang.String convertIdToClassName(int aClassId, boolean aQueueClassType) throws VWException
aClassId
- The Class ID of the name being retrievedaQueueClassType
- true
to
convert the ID of a queue; false
to convert the ID of
a roster.VWException
- Causes include user lack of administrative
privilege to call this method.public boolean recoverUser(java.lang.String userName, java.lang.String[] queueNames) throws VWException
fetchQueueNames(int)
. Recovery unlocks
the user's work items if an event has caused them to be left
locked. If the argument
for the queueNames parameter is null, all queues are recovered.
Administrative authority is required to perform queue recovery
for work objects locked by another user.userName
- Null or the name of the user you
wish to recover. A null value indicates the current user.queueNames
- A list of the names of the
queues to recover. Null is allowed and indicates that all
queues are to be recovered, but a null member in a list causes an
exception.true
means success; false
,
otherwise.VWException
- Causes include system conditions that make a
user or queue unavailable to the program, such as the following:
public VWLog fetchEventLog(java.lang.String eventLogName) throws VWException
eventLogName
- An event log name.
A list of valid event log names can be retrieved with
fetchEventLogNames()
.VWException
- public java.lang.String[] fetchEventLogNames() throws VWException
VWException
- fetchEventLog( String )
public void setAuditState(java.lang.String fileName, java.lang.Integer[] options) throws java.lang.Exception
fileName
- The full path name of the
file to which the audit will log the information; specify null
to disable logging.options
- An integer value used to specify audit logging
options, containing values as shown below:
VWException
- public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRouterURL()
public VWSystemAdministration fetchSystemAdministration() throws VWException
VWException
- Thrown if the method cannot
get system administration information for the Process
Enginesystem.public VWSystemConfiguration fetchSystemConfiguration() throws VWException
VWException
- Thrown if the method cannot
get system configuration information for a system.public VWUserInfo fetchUserInfo(java.lang.String theName) throws VWException
theName
- The name of the user about
whom you wish to retrieve informationVWException
- Thrown if the method cannot
get general user information about a specified user.public VWSecurityList fetchUserGroups(int maxBufferSize) throws VWException
bufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
greater than 0 (zero).VWException
- Thrown if the method cannot
get group names for the Process Engine.public VWSecurityList fetchUsers(int maxBufferSize, boolean includeGroups) throws VWException
bufferSize
- Maximum number of elements to return in one fetch.
You must specify a value greater than 0 (zero).includeGroups
- true
to return a
VWSecurityList collection containing the names of both users and
groups; false
to return only user names.VWException
- VWSecurityList
public VWSecurityList findUsers(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws VWException
searchPattern
- A String of alphanumeric characters
that will be used for comparison to user names to determine if
a name matches. The comparison is performed according to the
method specified by the searchType parameter. A null search
pattern is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- A value that specifies the way the search
pattern (see the searchPattern parameters) string is used
for comparison, to determine a match for inclusion in the result
set. Values of the searchType parameter specify the
comparisons as follows:
sortType
- Value determines the type of sorting the security
database server performs on the returned set of records, as follows:
maxBufferSize
- Maximum number of elements to return in one
fetch. You must specify a value greater than 0 (zero).VWException
- Thrown for various causes. Causes
include if the database security type is not DS_TYPE_LDAP
(indicating an LDAP database), or if the database is not
correctly configured to complete the sorting that the method call
requires.VWSecurityList
public VWSecurityList findGroups(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws VWException
searchPattern
- A String of alphanumeric characters
that will be used for comparison to group names to determine if
a group name matches. The comparison is performed according to
the method specified by the searchType parameter. A null search
pattern is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- A value that specifies the way the search
pattern (see the searchPattern parameters) string is used
for comparison, to determine a match for inclusion in the result
set. Values of the searchType parameter specify the
comparisons as follows:
sortType
- Value determines the type of sorting the security
database server performs on the returned set of records, as
follows:
maxBufferSize
- Maximum number of elements to return in one
fetch. You must specify a value greater than 0 (zero).VWException
- Thrown for various causes. Causes
include if the database security type is not DS_TYPE_LDAP
(indicating an LDAP database), or if the database is not
correctly configured to complete the sorting that the method call
requires.VWSecurityList
public int getSecurityDatabaseType() throws VWException
VWException
- Thrown for various causes. Causes
include if the database security type is not DS_TYPE_LDAP
(indicating an LDAP database).VWSecurityList
,
DS_TYPE_SEC
,
DS_TYPE_LDAP
public int getDatabaseType() throws VWException
public VWUserInfo fetchCurrentUserInfo() throws VWException
public VWTransferResult transfer(VWWorkflowDefinition theWorkflow, java.lang.String theWFDocKey, boolean theLinked, boolean theMakeNewWorkSpace) throws VWException
VWWorkflowDefinition.getName()
method of of the input
workflow definition.theWorkflow
- A workflow definition object.
theWFDocKey
- The document identifier. Normally,
this would be a unique Content Engine or Content Services
document identifier; however, the String may be null, or it may
be an arbitrary String if the application does not require the
work class to be mapped back to a document repository.
If this parameter value is non-null it will be stored in the transferred work class as a String field named F_SourceDoc, You can use this F_SourceDoc field to retrieve the document containing the VWWorkflow definition for the work class.
theLinked
- A boolean control value: true
indicates there is a link from a document in a library
or object store to the transferring workflow;
false
indicates there is no such link.
Use this flag to ensure that the Process Engine does not remove
a workspace that is needed by Content Services or
the Content Engine for a document link,
which can occur when the Process Engine cleans up
unused Process Engine workspaces.
theMakeNewWorkSpace
- A boolean control value:
true
transfers the workflow definition to a new workspace on the
Process Engine; false
transfers the workflow
definition to the current workspace on the Process Engine.VWException
- VWTransferResult
,
VWWorkflowDefinition
public VWStepElement createWorkflow(java.lang.String workflowIdentifier) throws VWException
VWTransferResult
object
or a workflow
definition name
(work class name).
workflowIdentifier
- The "workflow definition name"
,
which is the work class name, or the Process
version String obtained from a
VWTransferResult.getVersion()
method.VWStepElement.doDispatch()
.VWException
- This method throws an exception for conditions
that include the following:
public VWNewWorkObject createNewWorkObject(java.lang.String workClassName) throws VWException
createLiveWorkObject(String[], Object[], String, int)
Warning: Only one work class can apply to a single workflow roster.
workClassName
- The name of the work
class the users transferred to the Process Engine.VWException
- Thrown if the method cannot
create a new workflow object from a client.createLiveWorkObject(java.lang.String[], java.lang.Object[], java.lang.String, int)
public boolean isMemberOfGroup(java.lang.String groupName) throws VWException
groupName
- The group name against which to check
user membershiptrue
if the user
is a member of the group specified in the groupName parameter;
false
, otherwise.VWException
- Thrown for various causes. One possible
cause is if the group name specified in the groupName parameter
is not found.public boolean[] fetchIsGroup(java.lang.String[] names) throws VWException
name
- List of possible group namestrue
if the name is a group returns true,
false
, otherwise.VWException
- Thrown for various causes.public java.lang.String getToken() throws VWException
VWException
- Thrown for various causes. Possible
causes could be Content Services or Content Engine errors.public VWStepProcessorInfo[] fetchStepProcessors(int processorFlag) throws VWException
processorFlag
- An integer that specifies the step
processor types for which you want information, according to
the following filter values:
You can perform a bitwise OR
of these flags to
combine their
properties, or you can use them individually.
Example:
// Fetch an array of VWStepProcessorInfo objects for all launch // processors and default-only, non-launch step processors. // VWStepProcessorInfo[] Processors = null; int iprocFlags = (PROCESSOR_LAUNCH | PROCESSOR_STEP_DEFAULT); Processors = mySession.fetchStepProcessors(iprocFlags);Note See the VWStepProcessorInfo Field Summary for more information on the step processor types.
VWException
- VWStepProcessorInfo
public VWStepProcessorInfo fetchLaunchStepProcessor(java.lang.String workflowIdentifier) throws VWException
workflowIdentifier
- Process version String
obtained from a VWTransferResult object.VWException
- transfer(VWWorkflowDefinition, String, boolean, boolean)
,
VWTransferResult
public VWStepProcessorInfo fetchStepProcessorInfo(java.lang.String processorIdentifier) throws VWException
processIdentifier
- The step processor ID, as a unique integer
in String formatVWException
- Thrown if the method
cannot retrieve the step processor object.VWStepProcessorInfo
public boolean checkWorkflowIdentifier(java.lang.String workflowIdentifier) throws VWException
true
if a workflow
with the ID specified in the workflowIdentifier parameter
exists on the Process Engine; false
, otherwise.VWException
- Causes includes passing in a work class
workflowIdentifier rather than a workflow version ID.VWTransferResult
,
transfer(VWWorkflowDefinition, String, boolean, boolean)
public int getIsolatedRegion() throws VWException
public void setProductId(int theProductId) throws VWException
setDefaultWebApplication(int)
theProductId
- An integer that specifies the
product id for the session.
For example, Process Engine requires this to be set to
PRODUCT_BPS (integer value 2).VWException
- This method can throw exceptions. Causes
include an invalid product ID.public void setDefaultWebApplication(int theWebApplicationId) throws VWException
The Web Application ID enables the workflow system to use web
application-specific program implementations. For example, to
access the appropriate locations for sample step processors,
which can depend on the specific web application.
Note: The current default for a given isolated region
is WEBAPP_NONE.
theWebApplicationId
- An integer that specifies the
Web Application ID for the session. For example,
a WorkPlace web application is set to WEBAPP_WORKPLACE
(integer value 1). IDs in the range of 0 to 99 are reserved
for FileNet use. IDs 100-999 are available to customers.VWException
- Causes include an invalid product ID.getDefaultWebApplication()
public int getDefaultWebApplication() throws VWException
The Web Application ID enables the workflow system to use web
application-specific program implementations. For example, to
access the appropriate locations for sample step processors,
which can depend on the specific web application.
Note: The current default for a given isolated region
is WEBAPP_NONE.
VWException
- Causes include an invalid product ID.setDefaultWebApplication(int)
public static java.lang.String[] getActiveRouters(java.lang.String serverURL) throws VWException
serverURL
- the URL/UNC representation of the name of the
Process Engine's server.public static java.lang.String getDefaultRouter(java.lang.String serverURL) throws VWException
public VWProcess fetchProcess(int workSpaceId, int workClassId, java.lang.String workflowNumber) throws VWException
workSpaceId
- An integer value that is the workSpaceId
associated with the processworkClassId
- An integer value that is the workClassId
associated with the processworkflowNumber
- A String representation of the
workflowNumber associated with the processVWException
- Thrown if the method
cannot retrieve the workflow process containing this work
object.public VWCreateLiveWOResult[] createLiveWorkObject(java.lang.String[] fieldNames, java.lang.Object[] fieldValues, java.lang.String workflowIdentifier, int numberToCreate) throws VWException
The source workflow definition must exist on the Process Engine.
This implies that the VWServiceName and isolated region for
this identifier match those of the current VWSession object. This
can be verified by using a workflow version ID (rather than
a work class name) for the workflow identifier and validating
checkWorkflowIdentifier(String)
the workflow version ID before you call createLiveWorkObject().
fieldNames
- An array of strings containing the names of
the fields to update in the new work items, in the same order
that the values for those fields are supplied in the fieldValues
parameterfieldValues
- An array of objects whose values are supplied,
in order, to the fields named in the fieldNames parameterworkflowIdentifier
- The workflow definition name (work
class name) as returned by the VWWorkflowDefinition.getName()
method; or the workflow version ID (version property) as returned
by the VWTransferResult.getVersion() method. A VWTransferResult
object is returned by the
transfer(VWWorkflowDefinition,
String, boolean, boolean)
method.numberToCreate
- The number of work items to createVWException
- Causes include passing in a workflow
identifier that is not associated with any workflow on the
Process Engine.VWTransferResult
,
transfer(VWWorkflowDefinition, String, boolean, boolean)
public VWWorkflowSignature fetchWorkflowSignature(java.lang.String workflowIdentifier) throws VWException
workflowIdentifier
- The workflow
definition name, which is the work class name on the Process
Engine or the VWVersion String property stored by the Content
Engine or Content Services.VWException
- Causes include a null workflowIdentifier.public VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId, java.lang.String workflowIdentifier) throws VWException
fetchWorkflowDefinition(int,String, boolean)
which can handle a workflow definition that
references a work class from a previous
version of Process that was known as Panagon Visual
WorkFlo. It also can represent a workflow definition that
explicitly incorporates default terminate or malfunction maps.
workSpaceId
- The ID of the workspace from which to fetch
the workflow definition, or -1 for the current workspace.workflowIdentifier
- The workflow definition name (work
class name or the Process version String obtained from a
VWTransferResult object). If the workflowIdentifier
is a version String then the workSpaceId parameter
is ignored, and the workspace ID from the version String is used.VWException
- Thrown if this method cannot fetch a
workflow definition StringVWTransferResult
,
transfer(VWWorkflowDefinition, String, boolean, boolean)
public VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId, java.lang.String workflowIdentifier, boolean convert) throws VWException
workSpaceId
- The ID of the workspace from which to fetch
the workflow definition, or -1 for the current workspace.
workflowIdentifier
- The workflow definition name, which is
the work class name or the Process version String obtained from a
VWTransferResult object. convert
- The value true
indicates that the fetched workflow definition should be
converted, so that the workflow definition is correct and
complete in the following situations:
false
indicates that the returned workflow
definition will be in the same form in which it was transferred
to the Process Engine.
Conversion is not necessary if the returned workflow definition does not need to include inherited (not explicitly defined) terminate or malfunction maps, and the referenced work class has not been transferred from a previous version of Process that was known as Panagon Visual WorkFlo.
VWException
- Thrown in case of error, such as
an invalid input parameter.VWTransferResult
,
transfer(VWWorkflowDefinition, String, boolean, boolean)
public java.lang.String getServerName() throws VWException
VWException
- public java.lang.String getDefaultSecurityDomain() throws VWException
VWException
- public VWAttributeInfo fetchAttributes(int nFlag) throws VWException
System-wide attributes would be initialized with VWSystemAdministration.setAttributeInfo(VWAttributeInfo)
,
and persisted with VWSystemAdministration.commit()
. The region-specific attributes,
including VWQueueDefinition attributes, are initialized with
VWSystemConfiguration.setAttributeInfo(VWAttributeInfo)
and
saved with VWSystemConfiguration.commit()
.
nFlag
- Specifies which category of attribute information
will be returned: ATTRIBUTES_SYSTEM for system-wide
attributes, or ATTRIBUTES_REGION for region-specific
attributes.public boolean checkSystemWideFlagSetting(int flagOptions) throws VWException
true
if the option is
enabled; otherwise, false
.VWException
- Causes include an invalid product ID.VWSystemAdministration
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |