|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWSystemAdministration
public final class VWSystemAdministration
Use this class to access and modify system-wide administration information or tasks. Examples of tasks managed with this class include the following:
VWSession.fetchSystemAdministration()
Field Summary | |
---|---|
static int |
SYSTEM_WIDE_DELETE_PARENT
Value of 4, indicating that the server should delete parent work objects when the children do not merge. |
static int |
SYSTEM_WIDE_DISABLE_NOTIFICATION
Value of 64, indicating that e-mail notification should be disabled on the server. |
static int |
SYSTEM_WIDE_DISABLE_STATISTICS
Value of 16, indicating that statistics should be disabled on the server. |
static int |
SYSTEM_WIDE_DISABLE_TERMINATE
Value of 32, indicating that logging of workflow termination events (F_EventType 165) should be disabled on the server. |
static int |
SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES
Value of 2048, indicating that the option to run some rules asynchronously is enabled. |
static int |
SYSTEM_WIDE_FLAG_CONSISTENT_RETURN
Value of 512, indicating that returns will be consistent with the behavior of the return system instruction. |
static int |
SYSTEM_WIDE_FLAG_ENABLE_RULES
Value of 1024, indicating that rules engine is enabled. |
static int |
SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG
Value of 256, indicating that the analysis engine should be disabled on the server. |
static int |
SYSTEM_WIDE_LOOP_DETECTION
Value of 1, indicating that the server should perform loop detection. |
static int |
SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS
Value of 2, indicating that the server should remove expired timers from parent work objects. |
static int |
SYSTEM_WIDE_UNDEFINED
Value of 0, indicating the system-wide flag is undefined. |
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. |
void |
commit()
Saves system administration changes to the system-wide configuration on the workflow server. |
VWUserInfo |
createUserInfo()
Deprecated. VWUserInfo records are created on the server in P8PE4.0 |
void |
deleteUserInfo(java.lang.String theUserName)
Deletes information about a specified user. |
VWUserInfo |
fetchUserInfo(java.lang.String theUserName)
Fetches information about a specified user. |
VWAttributeInfo |
getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
int |
getSessionTimeOut()
Gets the number minutes before a client/server session timeout. |
int |
getStatisticsConsolidationInterval()
Gets the interval (minutes) between updates to the domain-wide statistics stored in the database. |
int |
getStatisticsSnapshotInterval()
Deprecated. Not replaced |
int |
getSystemWideFlags()
Gets an integer that represents the combined system-wide configuration flags. |
void |
initializeRegion()
Initializes the current region. |
void |
removeAllRegions()
Deletes information for all isolated regions. |
void |
removeLinkFlag(java.lang.String theDocument)
Deletes the linked-document indicator from a transferred work space. |
void |
removeRegion()
Deletes the current isolated region and information that pertains to it. |
void |
removeWorkflowDatabase()
Deletes all workflow information from the database. |
void |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
setSessionTimeOut(int theSessionTimeOut)
Sets the number of minutes used for all client/server sessions. |
void |
setStatisticsConsolidationInterval(int theInterval)
Sets the interval (minutes) between updates to the domain-wide statistics stored in the database. |
void |
setStatisticsSnapshotInterval(int theInterval)
Deprecated. Not replaced |
void |
setSystemFlags(int theFlags)
Sets the system-wide configuration flags. |
void |
setSystemWideFlags(int theFlags)
Deprecated. Replaced by setSystemFlags(int) , which requires
commit() to save the flag values to the workflow
server. This deprecated method saved the flag values
automatically. |
java.lang.String |
toString()
Gets a string representation of the VWSystemAdministration object. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int SYSTEM_WIDE_UNDEFINED
public static final int SYSTEM_WIDE_LOOP_DETECTION
public static final int SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS
public static final int SYSTEM_WIDE_DELETE_PARENT
public static final int SYSTEM_WIDE_DISABLE_STATISTICS
public static final int SYSTEM_WIDE_DISABLE_TERMINATE
public static final int SYSTEM_WIDE_DISABLE_NOTIFICATION
public static final int SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG
public static final int SYSTEM_WIDE_FLAG_CONSISTENT_RETURN
public static final int SYSTEM_WIDE_FLAG_ENABLE_RULES
public static final int SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES
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 VWUserInfo createUserInfo() throws VWException
VWException
VWSession.fetchUserInfo, VWUserInfo
public void deleteUserInfo(java.lang.String theUserName) throws VWException
theUserName
- The name of the user
VWException
VWUserInfo
public VWUserInfo fetchUserInfo(java.lang.String theUserName) throws VWException
theUserName
- The name of the user
VWException
- Causes include the situation where the
user specified in the theUserName parameter does not exist in
this domain.VWUserInfo
public int getStatisticsConsolidationInterval() throws VWException
VWException
public void setStatisticsConsolidationInterval(int theInterval) throws VWException
theInterval
- The number of minutes between database updates.
VWException
public void setSystemWideFlags(int theFlags) throws VWException
setSystemFlags(int)
, which requires
commit()
to save the flag values to the workflow
server. This deprecated method saved the flag values
automatically.
theFlags
- An integer that specifies the bitwise OR operation
value of the system-wide flags shown in the
VWSystemAdministration field summary.
VWException
public void setSystemFlags(int theFlags) throws VWException
commit()
to save the flag settings
to the workflow server.
theFlags
- An integer that specifies the bitwise OR operation
value of the system-wide flags shown in the VWSystemAdministration
field summary.
VWException
public int getSystemWideFlags() throws VWException
VWException
public int getSessionTimeOut() throws VWException
VWException
public void setSessionTimeOut(int theSessionTimeOut) throws VWException
theInterval
- The number of minutes before a client/server
session times out.
VWException
public void commit() throws VWException
Note: Before calling this method, configuration changes, including attributes set with setAttributeInfo(), reside only in local memory.
VWException
public int getStatisticsSnapshotInterval() throws VWException
VWException
public void setStatisticsSnapshotInterval(int theInterval) throws VWException
VWException
public void initializeRegion() throws VWException
VWException
public void removeRegion() throws VWException
VWException
public void removeAllRegions() throws VWException
VWException
public void removeWorkflowDatabase() throws VWException
VWException
public void removeLinkFlag(java.lang.String theDocument) throws VWException
VWSession.transfer(VWWorkflowDefinition, String, boolean, boolean)
.
theDocument
- The work class name from which to remove
the linked-document indicator.
VWException
- Causes include a situation where the
work class name
does not exist on the current isolated region.public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format.
VWException
getAttributeInfo()
,
commit()
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |