|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWSession
public final class 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:
getRoster
or getQueue
method to create instances of the VWRoster
or VWQueue class.fetchRosterNames
or
fetchQueueNames
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. Log on using the JiGlue COM Bridge (JiGlue.Util) to instantiate a VWSession object,
then invoke the VWSession.logon method with the logon(String, String, String)
parameters.
If you want to use the Application Engine ASP files with this session, call the setProductId
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
,
VWRoster
,
VWQueue
,
Serialized FormField Summary | |
---|---|
static int |
ALL_WORKFLOW_SIGNATURES
Value of 0. |
static int |
ATTRIBUTES_REGION
Value of 2. |
static int |
ATTRIBUTES_SYSTEM
Value of 1. |
static int |
DATABASE_DB2
Value of 3. |
static int |
DATABASE_ORACLE
Value of 1. |
static int |
DATABASE_SQL2000
Value of 2. |
static int |
DATABASE_SQL2000ODBC
Value of 6. |
static int |
DS_TYPE_LDAP
Value of 1. |
static int |
DS_TYPE_SEC
Value of 0. |
static int |
MILESTONE_QUERY_WORKFLOW_NUMBER
Value of 1. |
static int |
MILESTONE_QUERY_WORKOBJECT_NUMBER
Value of 0. |
static int |
PRIVILEGES_ADMINISTRATOR
Value of 1. |
static int |
PRIVILEGES_CONFIGURATION
Value of 2. |
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. |
static int |
QUEUE_PROCESS
Value of 1. |
static int |
QUEUE_SYSTEM
Value of 4. |
static int |
QUEUE_USER_CENTRIC
Value of 2. |
static int |
QUEUE_USER_CENTRIC_FOR_USER_ONLY
Value of 32. |
static int |
RECEIVE_WORKFLOW_SIGNATURES
Value of 1. |
static int |
SEARCH_TYPE_CONTAINS
Value of 4. |
static int |
SEARCH_TYPE_CUSTOM
Value of 1. |
static int |
SEARCH_TYPE_NONE
Value of 0. |
static int |
SEARCH_TYPE_PREFIX_MATCH
Value of 2. |
static int |
SEARCH_TYPE_SUFFIX_MATCH
Value of 3. |
static int |
SERVER_FILE_SCHEMA
Value of 1. |
static int |
SERVER_FILE_TRANSFORM
Value of 2. |
static int |
SORT_TYPE_ASCENDING
Value of 0. |
static int |
SORT_TYPE_DESCENDING
Value of 0. |
static int |
SORT_TYPE_NONE
Value of 0. |
static int |
WEBAPP_COLLABORATION
Value of 4. |
static int |
WEBAPP_CUSTOM
Value of 100. |
static int |
WEBAPP_ECM_WIDGETS
Value of 8. |
static int |
WEBAPP_NONE
Value of 0. Indicates the web application is not set. |
static int |
WEBAPP_OPEN_CLIENT
Value of 3. |
static int |
WEBAPP_RECORDS_MANAGER
Value of 6. |
static int |
WEBAPP_WCM
Value of 5. |
static int |
WEBAPP_WEB_WORKFLO
Value of 2. |
static int |
WEBAPP_WORKPLACE
Value of 1. |
static int |
WEBAPP_WORKPLACE_XT
Value of 7. |
Constructor Summary | |
---|---|
VWSession()
Use this with FileNet Web Services or Open Client. |
|
VWSession(java.lang.String url)
Creates a new session in an environment where the Java™ Authentication and Authorization Service (JAAS) context is already established. |
|
VWSession(java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Establishes a new session based on a specified connection point. |
|
VWSession(java.lang.String domain,
java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Establishes a session for a specified domain and connection point. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
boolean |
checkSystemWideFlagSetting(int flagOptions)
Checks the system wide flag settings given the VWSystemAdministration System wide flag option. |
boolean |
checkWorkflowIdentifier(java.lang.String workflowIdentifier)
Indicates whether or not a workflow is on the Process Engine, based on the specified workflow version ID. |
int |
convertClassNameToId(java.lang.String aClassName,
boolean aQueueClassType)
Converts a roster or queue name to a class ID. |
VWParticipant[] |
convertIdsToUserNamesPx(long[] userIds)
Converts a list of user IDs to the associated user names (contained in a VWParticipant array). |
java.lang.String |
convertIdToClassName(int aClassId,
boolean aQueueClassType)
Converts a class ID to a roster or queue name. |
java.lang.String |
convertIdToUserName(int aUserId)
Converts a user ID to a user name. |
VWParticipant |
convertIdToUserNamePx(long userId)
Converts a single user ID to the associated user name (contained in a VWParticipant array). |
int |
convertUserNameToId(java.lang.String aUserName)
Converts a user name in three-part format (name:domain:organization) to a user ID. |
VWAttachmentTrackingQuery |
createAttachmentTrackingQuery(VWAttachment anAttachment)
Creates a VWAttachmentTrackingQuery object that describes which running/active workflows are currently referencing a particular attachment. |
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. |
javax.mail.Session |
createMailSession()
Creates a java mail session based on email notification configuration information specified on a Process Engine server. |
VWStepElement |
createWorkflow(java.lang.String workflowIdentifier)
Launches a workflow defined by a transferred workflow definition, as specified by the workflow version or the workflow definition name (work class name). |
java.lang.Boolean[] |
fetchAttachmentIsReferenced(VWAttachment[] theAttachments)
Checks an array of attachment objects to see if an active workflow is referencing any of the attachment objects and returns a Boolean value for each attachment, true if the attachment is referenced by a currently running workflow; false otherwise. |
VWRosterElement[] |
fetchAttachmentIsReferencedBy(VWAttachment anAttachment)
Deprecated. Replaced by createAttachmentTrackingQuery |
VWRosterElement[] |
fetchAttachmentIsReferencedBy(VWAttachment anAttachment,
int theLimit)
Deprecated. Replaced by createAttachmentTrackingQuery(VWAttachment) |
VWAttributeInfo |
fetchAttributes(int nFlag)
Fetches system-wide or region-specific attribute information from the Process Engine for the current logged-on session. |
java.util.Locale[] |
fetchAvailableLocales()
Gets the set of available locales registered on the Process Engine server. |
VWUserInfo |
fetchCurrentUserInfo()
Gets information about the user logged on to this session. |
VWLog |
fetchEventLog(java.lang.String eventLogName)
Retrieves the specified event log. |
java.lang.String[] |
fetchEventLogNames()
Returns a list of all event log names. |
java.lang.String |
fetchFileFromServer(java.lang.String theFileName,
int theFileType)
Gets a file for the Process Engine server. |
boolean[] |
fetchIsGroup(java.lang.String[] names)
Indicates whether or not the members of a list of names are names of groups. |
java.lang.String[] |
fetchLaunchableWorkClassNames()
Retrieves a list of the names of all work classes within the isolated region that can be launched by the current user. |
VWStepProcessorInfo |
fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
Retrieves the launch step processor information, based on the specified workflow version (obtained from a VWTransferResult object). |
boolean |
fetchLimitApplicationFunctionalityFlag()
Returns the value of the Full Workflow Functionality flag set in the Process Task Manager. |
VWMilestoneElement[] |
fetchMilestonesFromRoster(java.lang.String rosterName,
java.lang.String queryValue,
int queryFlag,
int milestoneLevel)
Fetches the milestone data for the current workflow process having work objects in the specified roster. |
VWWorkflowSignature[] |
fetchMultipleWorkflowSignatures(int flags)
Returns an array of workflow signatures. |
VWRole |
fetchMyRole(java.lang.String roleName,
java.lang.String appSpaceName)
Retrieves the specified role associated with the user currently logged in. |
VWRole[] |
fetchMyRoles(java.lang.String appSpaceName)
Retrieves the roles associated with the user currently logged in. |
VWParticipant[] |
fetchParticipantsPx(java.lang.String secDomainName,
java.lang.String[] theNameList)
Gets general user security information about specified users in a domain. |
int |
fetchPrivileges()
Retrieves the privileges for the current user. |
VWProcess |
fetchProcess(int workSpaceId,
int workClassId,
java.lang.String workflowNumber)
Returns the workflow process containing this work object. |
java.lang.String[] |
fetchQueueNames(int fetchFlag)
Retrieves the names of queues within the current isolated region and within the scope of the specified queue type or types. |
java.lang.String[] |
fetchRosterNames(boolean ignoreSecurity)
Retrieves a list of the names of all rosters within the isolated region. |
VWSecurityDomain[] |
fetchSecurityDomains()
Returns all security domains. |
java.util.Locale |
fetchServerLocale()
Gets the default locale for the Process Engine server. |
VWStepProcessorInfo |
fetchStepProcessorInfo(java.lang.String processorIdentifier)
Returns 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 information 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)
Deprecated. Replaced by findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWParticipantList |
fetchUserGroupsPx(int maxBufferSize)
Deprecated. Replaced by findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWUserInfo |
fetchUserInfo(java.lang.String theName)
Gets general user information about a specified user. |
VWUserInfo[] |
fetchUserInfoList(java.lang.String[] theNameList)
Gets general user information about specified users. |
VWUserInfo[] |
fetchUserRecords(int maxBufferSize,
boolean throwException)
Fetches a collection of all user environment records that exists on the Process Engine. |
VWSecurityList |
fetchUsers(int maxBufferSize,
boolean bIncludeGroups)
Deprecated. Replaced by findUsers(String searchPattern, int searchType, int sortType, int maxBufferSize)
findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWParticipantList |
fetchUsersPx(int maxBufferSize,
boolean bIncludeGroups)
Deprecated. Replaced by findUsersByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize)
findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize) |
java.lang.String[] |
fetchWorkClassNames(boolean ignoreSecurity)
Retrieves a list of the names of all work classes within the isolated region. |
java.lang.String[] |
fetchWorkClassNames(boolean ignoreSecurity,
java.lang.String inheritFromWorkClassName)
Retrieves a list of the names of the work classes within the current isolated region that inherit from the specified work class. |
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, based on the specified workspace ID and the work class name or the workflow version. |
VWWorkflowSignature |
fetchWorkflowSignature(java.lang.String workflowIdentifier)
Retrieves the workflow signature, based on the specified 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. |
VWParticipantList |
findGroupsByDomain(java.lang.String secDomainName,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all group names defined within the specified LDAP security 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. |
VWParticipantList |
findUsersByDomain(java.lang.String secDomainName,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all user names defined within the specified LDAP security domain, matching them for inclusion in the result collection according to this method's search pattern and search type arguments. |
java.util.Locale |
getClientLocale()
Get the client locale to be used when translating to a language other than the default language of the Process Engine server. |
java.lang.String |
getConnectionPointName()
Gets the name of the connection point used for this session. |
long |
getCurrentUserSecId()
Returns the user ID for the user currently logged on. |
java.lang.String |
getCurrentVersion()
Gets the current version of the Process Engine API. |
int |
getDatabaseType()
Gets the database
configuration type for the workflow database. |
VWSecurityDomain |
getDefaultSecurityDomain()
Deprecated. P8 PE BPM 4.0 does not support the concept of "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. |
java.lang.String |
getPEServerName()
Gets the Network Clearing House (NCH) domain name for the Process Engine server. |
VWQueue |
getQueue(java.lang.String queueName)
Gets the queue object identified by the specified queue name. |
java.lang.String[] |
getQueueNames(boolean includeSystem)
Deprecated. Replaced by fetchQueueNames . |
VWRoster |
getRoster(java.lang.String rosterName)
Gets the roster object identified by the specified roster name. |
java.lang.String[] |
getRosterNames()
Deprecated. Replaced by fetchQueueNames(int) or
fetchRosterNames(boolean) . |
java.lang.String |
getRouterURL()
Gets the connection point name, formatted 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. |
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. |
boolean |
isMemberOfGroupByDomain(java.lang.String domainName,
java.lang.String groupName)
Indicates whether or not the user currently logged on is a member of the specified group in the specified domain. |
boolean |
isRegionInitialized()
Indicates whether the isolated region has been initialized. |
void |
logoff()
Ends the session with the Process Engine and frees all resources. |
void |
logon(java.lang.String url)
Logs on to an existing session in an environment where the JAAS context is already established. |
void |
logon(java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Logs onto an existing session. |
void |
logonByDomain(java.lang.String domain,
java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Logs on to an existing session for a specified domain. |
void |
logonWithToken(java.lang.String theToken,
java.lang.String connectionPointName)
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 . |
void |
setAuditState(java.lang.String fileName,
java.lang.Integer[] options)
Deprecated. Replaced by inserting a copy of the fnlog4j.properties file in the fnsw\java\jre\lib directory. Edit this file to view or change logging properties. For detail information on the components of the fnlog4j.properties file, see the documentation on the members of the java.util.logging class. |
void |
setBootstrapCEURI(java.lang.String bootstrapCEURI)
Sets the Content Engine URI to be used in discovering the connection points. |
void |
setBootstrapConfiguration(java.io.InputStream bootstrapConfigStream)
Sets the input stream to use for the Content Engine URI configuration data. |
void |
setClientLocale(java.util.Locale myLocale)
Sets the client locale to be used when translating to a language other than the default language of the Process Engine server. |
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 connection point name and isolated region, formatted as follows: <:host name>:<port>/<router name><space><integer> |
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. |
VWTransferResult |
transferWFCollection(VWWorkflowCollectionDefinition theWorkflowColl,
java.lang.String theWFDocKey,
boolean theLinked,
boolean theMakeNewWorkSpace)
Transfers a workflow definition collection object, saving it on the Process Engine.The work class names saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method for each individual
workflow definition in the workflow collection parameter. |
void |
updateAPIUserCache()
Refreshes the internal cache of user names, which is populated by calls from convertIdtoUserName(), convertUserNametoId() and getUserNames(), for performance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int QUEUE_PROCESS
fetchQueueNames
method to return the name of each
process queue (a queue that holds objects for an external workflow to process).
public static final int QUEUE_USER_CENTRIC
fetchQueueNames
method to return the name of each
user queue (the individual queue of a workflow user, similar
to an inbox for the user).
public static final int QUEUE_SYSTEM
fetchQueueNames
method to return the name of each
system queue (a queue that the system configures).
public static final int QUEUE_IGNORE_SECURITY
fetchQueueNames
method to return the name of queues
to which the user has no access.
public static final int QUEUE_USER_CENTRIC_FOR_USER_ONLY
fetchQueueNames
method to return the name of the
user-centric queue associated with the user information. Use with
QUEUE_USER_CENTRIC to filter out queues on multiple servers that
do not apply to the current user logon to this VWSession object.
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_COLLABORATION
public static final int WEBAPP_WCM
public static final int WEBAPP_RECORDS_MANAGER
public static final int WEBAPP_WORKPLACE_XT
public static final int WEBAPP_ECM_WIDGETS
public static final int WEBAPP_CUSTOM
public static final int DATABASE_ORACLE
public static final int DATABASE_SQL2000
public static final int DATABASE_DB2
public static final int DATABASE_SQL2000ODBC
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 MILESTONE_QUERY_WORKOBJECT_NUMBER
public static final int MILESTONE_QUERY_WORKFLOW_NUMBER
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
public static final int SERVER_FILE_SCHEMA
fetchFileFromServer
method to
specify a schema file.
public static final int SERVER_FILE_TRANSFORM
fetchFileFromServer
method to
specify a tranform file.
public static final int ALL_WORKFLOW_SIGNATURES
fetchMultipleWorkflowSignatures
.
public static final int RECEIVE_WORKFLOW_SIGNATURES
fetchMultipleWorkflowSignatures
.
public static final int PRIVILEGES_ADMINISTRATOR
public static final int PRIVILEGES_CONFIGURATION
Constructor Detail |
---|
public VWSession()
logon(String, String, String)
method.
public VWSession(java.lang.String url) throws VWException
Note: The Content Engine URI must be specified before attempting to establish the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
url
- The name of the connection point to use.
VWException
public VWSession(java.lang.String user, java.lang.String password, java.lang.String connectionPointName) throws VWException
Note: The Content Engine URI must be specified before attempting to establish the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
If the Content Engine URI is set, and the connection point name specified contains a valid entry, the user is connected to the connection point and logged on to the Process Engine.
user
- A String containing the name of a user with permissions to log on to the Process Engine.password
- A String containing the password for the specified user.connectionPointName
- A String containing the name of the connection point to use for this session.
VWException
- Thrown for various causes, including when the specified user is already logged on
to the Process Engine.public VWSession(java.lang.String domain, java.lang.String user, java.lang.String password, java.lang.String connectionPointName) throws VWException
Note: The Content Engine URI must be specified before attempting to establish the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
If the Content Engine URI is set, and the connection point and domain specified contain valid entries, the user is connected to the connection point and logged on to the Process Engine.
domain
- A String containing the domain name.user
- A String containing the name of a user with permissions to log on to the Process Engine.password
- A String containing the password for the specified user.connectionPointName
- A String containing the name of the connection point to use for this session.
VWException
- Thrown for various causes, including when the specified user is already logged on
to the Process Engine.Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public void logon(java.lang.String user, java.lang.String password, java.lang.String connectionPointName) throws VWException
Note: The Content Engine URI must be specified before attempting to establish the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
If the Content Engine URI is set, and the connection point and domain specified contain valid entries, the user is connected to the connection point and logged on to the Process Engine.
user
- A String containing the name of a user with permissions to log on to the Process Engine.password
- A String containing the password for the specified user.connectionPointName
- A String containing the name of the connection point to use for this session.
VWException
- Thrown for various causes, including when the specified user is already logged on
to the Process Engine.public void logon(java.lang.String url) throws VWException
logon(String, String, String)
.
Note: The Content Engine URI must be specified before attempting to establish the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
url
- The name of the connection point to use.
VWException
public void logonByDomain(java.lang.String domain, java.lang.String user, java.lang.String password, java.lang.String connectionPointName) throws VWException
logon(String)
) when the
transport is Web Services.
Note: The Content Engine URI must be specified before attempting to log on to the session. This can be specified in any of the following ways:
-Dfilenet.pe.bootstrap.ceuri=t3://hqruby:7001/FileNet/Engine
setBootstrapCEURI
method.setBootstrapConfiguration
method.RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
If the Content Engine URI is set, and the connection point and domain specified contain valid entries, the user is connected to the connection point and logged on to the Process Engine.
domain
- A String containing the domain name.user
- A String containing the name of a user with permissions to log on to the Process Engine.password
- A String containing the password for the specified user.connectionPointName
- A String containing the name of the connection point to use for this session.
VWException
- Thrown for various causes, including when the specified user is already logged on
to the Process Engine.public void logonWithToken(java.lang.String theToken, java.lang.String connectionPointName) throws VWException
theToken
- A String containing the process token. This cannot be null.connectionPointName
- The URL of the connection point, specified using the
Java™ Remote Method Invocation (RMI) protocol.
VWException
- Thrown for various causes, which can include invalid arguments, such as
timed-out and invalid tokens.getToken()
public VWRoster getRoster(java.lang.String rosterName) throws VWException
Use the fetchRosterNames
method to get a list
of 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 on to the additional server. If the additional server was previously accessed during the session, the logon information is shared.
rosterName
- A String containing the name of the roster. If a
translation source exists, the authored name is translated. The roster name is validated using RPC.
VWException
public VWQueue getQueue(java.lang.String queueName) throws VWException
Use the fetchQueueNames
method to get a list of
queue names.
In multiserver 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 on to the additional server. If the additional server was previously accessed during the session, the logon information is shared.
queueName
- A String containing the translated name of the queue.
If a translation source exists, the authored name is translated. The queue name is validated using RPC.
VWException
- Thrown if a specified parameter value is null.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
.
includeSystem
- Specify true
to return names
of all system queues; otherwise specify false
to
return only work queue names.
VWException
- Various causes, which can include
communications, server, and connection problems.public java.lang.String[] fetchQueueNames(int fetchFlag) throws VWException
fetchFlag
- An integer or integers corresponding to one or more
of the following queue type fields:
QUEUE_PROCESS
QUEUE_USER_CENTRIC
QUEUE_SYSTEM
QUEUE_IGNORE_SECURITY
QUEUE_USER_CENTRIC_FOR_USER_ONLY
Specify multiple queue types using a bitwise OR of the fields. For example:
// Fetch a list of queue names for process queues and system Queues, // whether this user has access privileges to the queues or not: int myQueueFlags = (QUEUE_PROCESS | QUEUE_SYSTEM | QUEUE_IGNORE_SECURITY); String[] QueueNames = null; QueueNames = MySession.fetchQueueNames(myQueueFlags);
VWException
- Thrown for various causes, including
communications, server, and connection problems.public java.lang.String[] getRosterNames() throws VWException
fetchQueueNames(int)
or
fetchRosterNames(boolean)
.
VWException
- Various causes, which can include
communications, server, and connection problems.public java.lang.String[] fetchRosterNames(boolean ignoreSecurity) throws VWException
ignoreSecurity
- A boolean value of true to return the names of all rosters, including
rosters that this user is not authorized to access; false to return only the names of rosters
that this user is authorized to access.
VWException
- Various causes, including
communications, server, and connection problems.public java.lang.String[] fetchLaunchableWorkClassNames() throws VWException
A work class can be launched by a user if that user has Create permission on the roster associated with the work class.
If a translation source exists, the authored names are translated.
VWException
- Thrown for various causes, including
communications, server, and connection problems.public java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity) throws VWException
ignoreSecurity
- This parameter is ignored, set it to true
or false
.
VWException
- Thrown for various causes, including
communications, server, and connection problems.public java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity, java.lang.String inheritFromWorkClassName) throws VWException
ignoreSecurity
- This parameter is ignored, set it to true
or false
.inheritFromWorkClassName
- A String containing the name of a work class from
which the returned work classes inherit. The empty string ("") or null specifies that
the names of all work classes within the isolated region are to be returned.
VWException
- Thrown for various causes, including
communications, server, and connection problems.public java.lang.String getCurrentVersion()
public int convertUserNameToId(java.lang.String aUserName) throws VWException
aUserName
- The user name in a three-part format as follows:
VWException
- Thrown for various causes, which can include:
convertIdToUserName(int)
public java.lang.String convertIdToUserName(int aUserId) throws VWException
aUserId
- The user ID used to retrieve the user name
null
. Inputting an invalid user Id returns
null
.
VWException
- Various causes, which can include:
null
and does not throw an exception.convertUserNameToId(java.lang.String)
public void updateAPIUserCache() throws VWException
VWException
- Thrown for various causes, including system or network errors with command session.convertUserNameToId(java.lang.String)
,
convertIdToUserName(int)
public int convertClassNameToId(java.lang.String aClassName, boolean aQueueClassType) throws VWException
aClassName
- A String containing the name of the workflow roster or
queue to convert. If a translation source exists, the authored name is translated.aQueueClassType
- Specify true to convert the name of a workflow queue;
false to convert the name of a workflow roster.
VWException
- Various causes, including lack of administrative
privileges to call this method.public java.lang.String convertIdToClassName(int aClassId, boolean aQueueClassType) throws VWException
aClassId
- An integer for the class ID of the roster or queue being retrieved.aQueueClassType
- Specify true to convert the ID of a queue; false to convert the ID of
a roster.
VWException
- Various causes, including lack of administrative
privileges to call this method.public boolean recoverUser(java.lang.String userName, java.lang.String[] queueNames) throws VWException
fetchQueueNames
. Recovery unlocks
the user's work items. 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.
VWException
- Various causes, which can 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
- A String containing the event log name. If a translation source exists, the
authored name is translated.
A list of valid event log names can be retrieved with fetchEventLogNames
.
VWException
public java.lang.String[] fetchEventLogNames() throws VWException
VWException
fetchEventLog
public void setAuditState(java.lang.String fileName, java.lang.Integer[] options) throws java.lang.Exception
For detail information on the components of the fnlog4j.properties file, see the documentation on the members of the java.util.logging class.
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:
java.lang.Exception
public java.lang.String toString()
<:host name>:<port>/<router name><space><integer>
toString
in class java.lang.Object
public java.lang.String getRouterURL()
<:host name>:<port>/<router name>
public java.lang.String getConnectionPointName() throws VWException
VWException
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 javax.mail.Session createMailSession() throws VWException
VWException
public VWUserInfo fetchUserInfo(java.lang.String theName) throws VWException
theName
- Name of the user for whom you wish
to retrieve information.
VWException
- Thrown for various causes,including a
null
or empty String as input.public java.lang.String fetchFileFromServer(java.lang.String theFileName, int theFileType) throws VWException
theFileName
- The path needed to locate the file on the Process Engine server. This
should be specified as a relative path. The Process Engine server will use the value of theFileType
to determine the absolute path.theFileType
- The type of file to retrieve. This must be one of the following:
VWException
- Thrown for various causes,including a
null, empty, or otherwise invalid value for theFileName.SERVER_FILE_TRANSFORM
,
SERVER_FILE_SCHEMA
public VWUserInfo[] fetchUserInfoList(java.lang.String[] theNameList) throws VWException
theNameList
- Users for whom information will be retrieved;
cannot be null
VWException
- Thrown for various causes, including when
the input theNameList argument is null.public VWSecurityList fetchUserGroups(int maxBufferSize) throws VWException
findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize)
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
public VWParticipantList fetchUserGroupsPx(int maxBufferSize) throws VWException
findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize)
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
- Thrown for various causes.VWParticipantList
,
VWParticipant
public VWSecurityList fetchUsers(int maxBufferSize, boolean bIncludeGroups) throws VWException
findUsers(String searchPattern, int searchType, int sortType, int maxBufferSize)
findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize)
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.bIncludeGroups
- true
to return a
VWSecurityList collection containing the names of both users and
groups; false
to return only user names.
VWException
VWSecurityList
public VWParticipantList fetchUsersPx(int maxBufferSize, boolean bIncludeGroups) throws VWException
findUsersByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize)
findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize)
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.bIncludeGroups
- true
to return a VWParticipantList collection containing
the VWParticipant object of both users and
groups; false
to return only user names.
VWException
- Thrown for various causes.VWParticipantList
,
VWParticipant
public VWSecurityList findUsers(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws VWException
searchPattern
- Comparison string, used to determine if
a name matches. Comparison is performed according to the
method specified by the searchType parameter. Null
is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- Specifies the way the comparison search
pattern (see the searchPattern parameters) String is used.
Specified values are as follows:
sortType
- Specifies the type of sorting the security
database server performs on the returned set of records, as follows:
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
- Thrown for various causes, including
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
- Comparison string, used to determine if
a name matches. Comparison is performed according to the
method specified by the searchType parameter. Null
is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- Specifies the way the comparison search
pattern (see the searchPattern parameters) String is used.
Specified values are as follows:
sortType
- Specifies the type of sorting the security
database server performs on the returned set of records, as follows:
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
- Thrown for various causes, including
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 VWParticipantList findUsersByDomain(java.lang.String secDomainName, java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws VWException
secDomainName
- Name of the specified security domain
searchPattern
- Comparison string, used to determine if
a name matches. Comparison is performed according to the
method specified by the searchType parameter. Null
is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- Specifies the way the comparison search
pattern (see the searchPattern parameters) String is used.
Specified values are as follows:
sortType
- Specifies the type of sorting the security
database server performs on the returned set of records, as follows:
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
- Thrown for various causes, including
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.VWParticipantList
public VWParticipantList findGroupsByDomain(java.lang.String secDomainName, java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws VWException
secDomainName
- Name of the specified security domainsearchPattern
- Comparison string, used to determine if
a name matches. Comparison is performed according to the
method specified by the searchType parameter. Null
is allowable for a searchType of SEARCH_TYPE_NONE.
searchType
- Specifies the way the comparison search
pattern (see the searchPattern parameters) String is used.
Specified values are as follows:
sortType
- Specifies the type of sorting the security
database server performs on the returned set of records, as follows:
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.
VWException
- Thrown for various causes, including
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.VWParticipantList
public int getSecurityDatabaseType() throws VWException
VWException
DS_TYPE_SEC
,
DS_TYPE_LDAP
public java.lang.String getPEServerName() throws VWException
VWException
public int getDatabaseType() throws VWException
database
configuration type
for the workflow database.
VWException
- Various causes, which can include
an isolated region that has not been initialized.public VWUserInfo fetchCurrentUserInfo() throws VWException
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 VWTransferResult transferWFCollection(VWWorkflowCollectionDefinition theWorkflowColl, java.lang.String theWFDocKey, boolean theLinked, boolean theMakeNewWorkSpace) throws VWException
VWWorkflowDefinition.getName()
method for each individual
workflow definition in the workflow collection parameter.
theWorkflowColl
- A workflow collection 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
,
VWWorkflowCollectionDefinition
public boolean isRegionInitialized() throws java.lang.Exception
true
indicates that the isolated region has
been initialized; false
indicates otherwise.
java.lang.Exception
public VWStepElement createWorkflow(java.lang.String workflowIdentifier) throws VWException
workflowIdentifier
- The workflow definition name (work
class name) as returned by VWWorkflowDefinition.getName
method, or the workflow version (version property) as returned
by VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
If a translation source exists, the authored work class name is translated.
VWStepElement.doDispatch
.
VWException
- This method throws an exception under the following conditions:
public boolean isMemberOfGroup(java.lang.String groupName) throws VWException
groupName
- The group name against which to check
user membership
true
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
names
- List of group names to be tested as group names.
true
if the name is the
name of a group, false
, otherwise.
VWException
public java.lang.String getToken() throws VWException
VWException
- Thrown for various causes. Some possible
causes could be Content Services or Content Engine processing
errors.public VWStepProcessorInfo[] fetchStepProcessors(int processorFlag) throws VWException
processorFlag
- An integer or integers corresponding to one or more of
the following types of step processors:
VWStepProcessorInfo.PROCESSOR_LAUNCH_DEFAULT
VWStepProcessorInfo.PROCESSOR_STEP_DEFAULT
VWStepProcessorInfo.PROCESSOR_DEFAULT
VWStepProcessorInfo.PROCESSOR_LAUNCH
VWStepProcessorInfo.PROCESSOR_STEP
Specify multiple processor types using a bitwise OR of the fields. For 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);
VWException
VWStepProcessorInfo
public VWStepProcessorInfo fetchLaunchStepProcessor(java.lang.String workflowIdentifier) throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
workflowIdentifier
- A String containing the workflow version obtained
by calling VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
If a translation source exists, the authored work class name is translated.
VWException
transfer
,
VWTransferResult
public VWStepProcessorInfo fetchStepProcessorInfo(java.lang.String processorIdentifier) throws VWException
processorIdentifier
- The step processor ID, as a unique integer
in String format
VWException
- Thrown for various causes,including a
null
or empty String as inputVWStepProcessorInfo
public boolean checkWorkflowIdentifier(java.lang.String workflowIdentifier) throws VWException
workflowIdentifier
- The workflow version (version property) as returned
by VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
VWException
- Various causes, which can includes passing in a work class
workflowIdentifier rather than a workflow version ID.VWTransferResult
,
transfer(VWWorkflowDefinition, String, boolean, boolean)
public int getIsolatedRegion() throws VWException
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
Web Application ID
for a logged-on session; the default web application is applied
to an initial transfer to a region.
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
- Various causes, which can include an invalid product ID.getDefaultWebApplication()
public int getDefaultWebApplication() throws VWException
Web Application ID
for a logged-on session; the default web application is applied
to an initial transfer to a region.
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
- Various causes, which can include an invalid product ID.setDefaultWebApplication(int)
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 process
VWException
- 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
)
the workflow version ID before you call this method.
fieldNames
- A String array 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 parameter.fieldValues
- An array of Objects whose values are supplied,
in order, to the fields named in the fieldNames parameter.workflowIdentifier
- The workflow definition name (work
class name) as returned by VWWorkflowDefinition.getName
method, or the workflow version (version property) as returned
by VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
If a translation source exists, the authored work class name is translated.
numberToCreate
- An integer for the number of work items to create.
VWException
- Various causes, included passing in a workflow
identifier that is not associated with any workflow.VWTransferResult
,
transfer
public VWWorkflowSignature fetchWorkflowSignature(java.lang.String workflowIdentifier) throws VWException
workflowIdentifier
- The workflow definition name (work
class name) as returned by VWWorkflowDefinition.getName
method, or the workflow version (version property) as returned
by VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
If a translation source exists, the authored work class name is translated.
VWException
- Various causes, which can include a null workflowIdentifier value.public VWWorkflowSignature[] fetchMultipleWorkflowSignatures(int flags) throws VWException
flags
- Either VWSession.ALL_WORKFLOW_SIGNATURES or VWSession.RECEIVE_WORKFLOW_SIGNATURES. If
ALL_WORKFLOW_SIGNATURES is specified, the signatures of all workflows in the current region on the Process Engine
server are returned. If RECEIVE_WORKFLOW_SIGNATURES is specified, the signatures of all workflows that
contain receive instructions are returned.
VWException
- Thrown when a specified flag is invalid.ALL_WORKFLOW_SIGNATURES
,
RECEIVE_WORKFLOW_SIGNATURES
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
- An integer for the ID of the workspace from which to fetch
the workflow definition. Specify "-1" to use the current workspace.
Note: This value is ignored if the value of the workflowIdentifier parameter is a workflow version.
workflowIdentifier
- The workflow definition name (work
class name) as returned by VWWorkflowDefinition.getName
method, or the workflow version (version property) as returned
by VWTransferResult.getVersion
.
You can get a VWTransferResult object using the
transfer
method.
If a translation source exists, the authored work class name is translated.
convert
- A boolean value of true indicates that the fetched workflow definition should be
converted, so that the workflow definition is correct and complete in the following situations:
A value of false indicates that the returned workflow definition is to 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 the Process Engine called Panagon Visual WorkFlow.
VWException
- Thrown for various causes, including when a specified parameter value is invalid.VWTransferResult
public java.lang.String getServerName() throws VWException
VWException
public VWSecurityDomain 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.
VWException
public boolean checkSystemWideFlagSetting(int flagOptions) throws VWException
flagOptions
-
true
if the option is
enabled; otherwise, false
.
VWException
- Various causes, which can include an invalid product ID.VWSystemAdministration
public VWRosterElement[] fetchAttachmentIsReferencedBy(VWAttachment anAttachment) throws VWException
createAttachmentTrackingQuery
anAttachment
- A VWAttachment object that describes
the attachment to be checked; null is accepted.
VWException
VWAttachment
,
VWRosterElement
,
VWSystemConfiguration.setTrackAttachmentReferences(boolean)
public VWRosterElement[] fetchAttachmentIsReferencedBy(VWAttachment anAttachment, int theLimit) throws VWException
createAttachmentTrackingQuery(VWAttachment)
anAttachment
- A VWAttachment object that describes
the attachment to be checked; null is accepted.theLimit
- A non-negative integer that limits the number of VWRosterElement objects
that will be returned. Specifying theLimit as zero (0) signifies that there is no limit.
VWException
VWAttachment
,
VWRosterElement
,
VWSystemConfiguration.setTrackAttachmentReferences(boolean)
public VWAttachmentTrackingQuery createAttachmentTrackingQuery(VWAttachment anAttachment) throws VWException
anAttachment
- The VWAttachment object for the attachment to be checked; null is accepted.
The attachment tracking system configuration option must be enabled for the current isolated region.
VWException
VWAttachmentTrackingQuery
,
VWAttachmentTrackingQuery.next
,
VWRosterElement
,
VWSystemConfiguration.setTrackAttachmentReferences
public java.lang.Boolean[] fetchAttachmentIsReferenced(VWAttachment[] theAttachments) throws VWException
theAttachments
- an array of VWAttachment objects that
will be checked for workflow references. A null array is
accepted.
VWException
VWAttachment
,
VWSystemConfiguration.setTrackAttachmentReferences(boolean)
,
createAttachmentTrackingQuery(VWAttachment)
public VWUserInfo[] fetchUserRecords(int maxBufferSize, boolean throwException) throws VWException
maxBufferSize
- An integer value specifying the maximum
number of elements to return in a fetch. Specify a value
with greater than 0 (zero), or use 0 (zero) or a negative value
to specify the default buffersize, which is 200.throwException
- Throw exception for missing LDAP users that were
deleted from LDAP after enviornment records were created.
VWException
VWUserInfo
public VWMilestoneElement[] fetchMilestonesFromRoster(java.lang.String rosterName, java.lang.String queryValue, int queryFlag, int milestoneLevel) throws VWException
rosterName
- A String containing the name of a roster having one of the following:
If a translation source exists, the authored roster name is translated.
queryValue
- A String containing a either workflow number or work object number, depending
on the which of these is specified for the queryFlag parameter.
queryFlag
- The integer value corresponding to MILESTONE_QUERY_WORKFLOW_NUMBER
or MILESTONE_QUERY_WORKOBJECT_NUMBER
.
MILESTONE_QUERY_WORKFLOW_NUMBER indicates the queryValue parameter contains a workflow number. To use the MILESTONE_QUERY_WORKFLOW_NUMBER option, the following conditions must be satisfied:
MILESTONE_QUERY_WORKOBJECT_NUMBER indicates the queryValue parameter contains a work object number.
milestoneLevel
- An integer indicating the maximum (inclusive) level property value
to use as the limiting value for the returned milestone elements.
VWException
- Thrown for various causes, including the following:
public VWParticipant convertIdToUserNamePx(long userId) throws VWException
userId
- A long representing the user ID.
VWException
- Various causes, including the following conditions:
convertUserNameToId(java.lang.String)
public VWParticipant[] convertIdsToUserNamesPx(long[] userIds) throws VWException
userIds
- Array of VWParticipant objects used to retrieve the user names. NoteSpecifying an
invalid user ID returns a null array element and does not throw an exception.
VWException
- Thrown under the following conditions:
convertUserNameToId
public VWSecurityDomain[] fetchSecurityDomains() throws VWException
VWException
public VWParticipant[] fetchParticipantsPx(java.lang.String secDomainName, java.lang.String[] theNameList) throws VWException
secDomainName
- User security domaintheNameList
- Non-null list of users for whom you wish
to retrieve information
VWException
- Thrown for various causes, including when
the theNameList argument is null.public boolean isMemberOfGroupByDomain(java.lang.String domainName, java.lang.String groupName) throws VWException
Note: Members of the Administrative group are considered to be members of every group.
domainName
- A String containing the domain name.groupName
- A String containing the group name.
VWException
- Thrown for various causes, including when
the specified group name is not found.public long getCurrentUserSecId() throws VWException
VWException
public boolean fetchLimitApplicationFunctionalityFlag() throws VWException
VWException
public void setBootstrapCEURI(java.lang.String bootstrapCEURI)
bootstrapCEURI
- A String containing the Content Engine URI to use (for example,
"t3://server:7001/FileNet/Engine")public void setBootstrapConfiguration(java.io.InputStream bootstrapConfigStream)
bootstrapConfigStream
- An InputStream object containing the configuration data. The
identifying line for the Content Engine URI must be specified in the stream as follows:
RemoteServerUrl=cemp:ContentEngineURI
Where ContentEngineURI is the URI of the Content Engine (for example, "t3://server:7001/FileNet/Engine").
public java.util.Locale[] fetchAvailableLocales() throws VWException
VWException
VWUserInfo.getPreferredLocale
,
VWUserInfo.setPreferredLocale
public java.util.Locale fetchServerLocale() throws VWException
VWException
setClientLocale
,
getClientLocale
public void setClientLocale(java.util.Locale myLocale) throws VWException
myLocale
- A Locale object for the client's Locale. Specify null to indicate that no translations
to other languages will be done. If a translation source exists, the authored information is translated.
VWException
fetchServerLocale
public java.util.Locale getClientLocale() throws VWException
VWException
fetchServerLocale
public VWRole[] fetchMyRoles(java.lang.String appSpaceName) throws VWException
The current user must be contained in the participant list (or a group in the participant list) for the roles.
appSpaceName
- A String containing the name of an application space in which
the roles are defined. This value can be null; in this case, all application spaces are
used.
Only those application spaces to which the current user has Read or Write access are included.
appSpaceName
is null).
VWException
public VWRole fetchMyRole(java.lang.String roleName, java.lang.String appSpaceName) throws VWException
The current user must be contained in the participant list (or a group in the participant list) for the role.
roleName
- A String containing the name of the role.appSpaceName
- A String containing the name of an application space in which
the roles are defined.
Only an application space to which the current user has Read or Write access is used.
VWException
public int fetchPrivileges() throws VWException
VWException
- Thrown for various causes, including
communications, server, and connection problems.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |