DataList
|
analyzePacket(Packet packet)
This method analyzes the given transaction packet for documents that have been disconnected by bug CTP-8067. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.
|
int
|
cancelDeleteTransaction(String txId, String group)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Cancels deletion of the specified transaction. The active user must have the group permission 'delete transaction' for the specified group.
|
int
|
cancelDeleteTransactions(String[] txIds, String group)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Cancels deletion of the specified transactions. The active user must have the group permission 'delete transaction' for the specified group.
|
int
|
changeTransactionGroup(String fromGroup, String toGroup)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Moves group association for all transactions from fromGroup to toGroup. Returns -1 if the user does not have permissions in both groups.
|
boolean
|
changeTransactionGroup(String txId, String fromGroup, String toGroup)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Moves group association for the specified transaction from fromGroup to toGroup. Returns false if the user does not have permissions in both groups.
|
int
|
changeTransactionGroup(String[] txIds, String fromGroup, String toGroup)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Moves group association for the specified transactions from fromGroup to toGroup. Returns the number of records modified or -1 on failure, such as if the user does not have permissions in both groups.
|
SystemDataView
|
getDeletedTransactionsView()
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions that have been deleted.
|
SystemDataView
|
getPalsByGroup(String group)
⚠Deprecated since 09-22-2015. Use ProfilePalManager.getPalsByGroup()
Returns a SystemDataView that can be used for accessing pals the active user has group access to.
|
DataList
|
getTransactionAuditLogs(String txId)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns audit logs for transaction. The active user must have permission to access transaction audit logs. Otherwise null returned
|
SystemDataView
|
getTransactionPalsByGroup(String group)
⚠Deprecated since 09-22-2015. Use ProfilePalManager.getTransactionPalsByGroup()
Returns a SystemDataView that can be used for accessing transaction pals for which the active user has createTransaction permission.
|
SystemDataView
|
getTransactionPalsBySharedGroup(String shareId)
⚠Deprecated since 11-11-2014. No replacement
Returns a SystemDataView that can be used for accessing transaction pals for which the active user has createTransaction permission. See profile.getSharedGroups to get a shareId.
|
SystemDataView
|
getTransactionViewByGroup(String group)
⚠Deprecated since 12-20-2013. Use getTransactionViewByGroup(group,palId)
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified group).
|
SystemDataView
|
getTransactionViewByGroup(String group, String palId)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified group) and the specified pal. Pass null for palId to include all pals. Pass * for palId to include only those transactions that have pals within the specified group. Pass a specific pal Id to isolate to a single pal.
|
SystemDataView
|
getTransactionViewByProfile(String group, String profileId)
Returns a SystemDataView that can be used for accessing transactions associated with the specified profile (a role has been assigned to the profile).
|
SystemDataView
|
getTransactionViewByRole()
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view returns a distinct list of transactions the active user has a role in.
|
SystemDataView
|
getTransactionViewByRoles()
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view may include duplicate transaction entries if the user has more than one role.
|
SystemDataView
|
getTransactionViewByScheduledDelete(String group)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions that have been scheduled for deletion for the logged in users' enterprise. The active user must have the group permission 'delete transaction' for the specified group.
|
SystemDataView
|
getTransactionViewBySharedGroup(String shareId)
⚠Deprecated since 11-11-2014. No replacement
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified shared group). See profile.getSharedGroups to get a shareId.
|
SystemDataView
|
getTransactionViewByUnassigned()
⚠Deprecated since 09-22-2015. No replacement. See ProfileTxManager for new APIs
Returns a SystemDataView that can be used for accessing transactions of the enterprise that are not assigned to a group. The active user must have the necessary enterprise management permission.
|
SystemDataView
|
getTransactionViewByUserRemoved()
⚠Deprecated since 09-22-2015. See ProfileTxManager
Returns a SystemDataView that can be used for accessing transactions associated with the logged in user with roles that have been removed. The view is restricted to the active profile.
|
int
|
moveUnassignedTransactions(String[] txIds, String toGroup)
Assigns the specified unassigned transactions to the specified group. Returns the number of records modified or -1 on failure, such as if the user does not have the necessary permissions.
|
int
|
removeUserAccessToTransaction(String txId, String role)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Removes the specified role(s) on the given transaction from the active user. Pass * for role to remove all roles.
|
int
|
removeUserAccessToTransactions(String[] txIds, String role)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Removes the specified role(s) on the given transaction(s) from the active user. Pass * for role to remove all roles.
|
DataList
|
repairPacket(Packet packet, String docname)
This method repairs the given transaction packet and attempts to reconnect orphaned documents that have been disconnected by bug CTP-8067. Documents with the same name are labeled doc-duplicate-index. No documents are deleted. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.
|
int
|
restoreUserAccessToTransaction(String txId, String role)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Restores the specified role(s) on the given transaction to the active user. Pass * for role to restore all roles.
|
int
|
restoreUserAccessToTransactions(String[] txIds, String role)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Restores the specified role(s) on the given transaction(s) to the active user. Pass * for role to restore all roles.
|
int
|
scheduleDeleteTransaction(String txId, String group, Date date, String datasetNames)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Schedules this transaction to be permanently deleted on the specified date or immediately if the date is in the past. If dataSetNames is not null, the related records in the identified dataSets will also be deleted. DataSetNames should be null or a comma separated list of dataSet names. This method returns 0 if the activation key does not permit deletions. The active user must have the group permission 'delete transaction' for the specified group.
|
int
|
scheduleDeleteTransactions(String[] ids, String group, Date date, String datasetNames)
⚠Deprecated since 09-22-2015. See ProfileTxManager
Schedules the transactions to be deleted on the specified date. See scheduleDeleteTransaction.
|
String
|
toString()
Returns a description of this object.
|
Method Detail
DataList analyzePacket(Packet packet)
This method analyzes the given transaction packet for documents that have been disconnected by bug CTP-8067. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.
Parameters:
-
Packet
packet
Required parameter.
Returns:
DataList
DataList Name: documents
DataList Fields: name, docSize, repairNeeded
Since:
09-22-2015
int cancelDeleteTransaction(String txId, String group)
Cancels deletion of the specified transaction. The active user must have the group permission 'delete transaction' for the specified group.
Parameters:
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int cancelDeleteTransactions(String[] txIds, String group)
Cancels deletion of the specified transactions. The active user must have the group permission 'delete transaction' for the specified group.
Parameters:
-
String[]
txIds
-
String
group
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int changeTransactionGroup(String fromGroup, String toGroup)
Moves group association for all transactions from fromGroup to toGroup. Returns -1 if the user does not have permissions in both groups.
Parameters:
-
String
fromGroup
-
String
toGroup
Returns:
int
Since:
11-12-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
boolean changeTransactionGroup(String txId, String fromGroup, String toGroup)
Moves group association for the specified transaction from fromGroup to toGroup. Returns false if the user does not have permissions in both groups.
Parameters:
-
String
txId
-
String
fromGroup
-
String
toGroup
Returns:
boolean
Since:
11-12-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int changeTransactionGroup(String[] txIds, String fromGroup, String toGroup)
Moves group association for the specified transactions from fromGroup to toGroup. Returns the number of records modified or -1 on failure, such as if the user does not have permissions in both groups.
Parameters:
-
String[]
txIds
-
String
fromGroup
-
String
toGroup
Returns:
int
Since:
01-13-2010
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getDeletedTransactionsView()
Returns a SystemDataView that can be used for accessing transactions that have been deleted.
Returns:
SystemDataView
DataList Name: DeletedTransactions
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
deleteDate |
Date |
|
testTx |
Boolean |
|
palId |
String |
|
firstName |
String |
|
lastName |
String |
|
Since:
03-20-2012
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getPalsByGroup(String group)
Returns a SystemDataView that can be used for accessing pals the active user has group access to.
Parameters:
-
String
group
Required parameter.
Returns:
SystemDataView
DataList Name: PalsByGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
testPal |
Boolean |
|
modeConsole |
Boolean |
|
modeTransaction |
Boolean |
|
modeWeb |
Boolean |
|
type |
String |
|
consoleVisible |
Boolean |
|
cubePalLimit |
Big Number |
|
Since:
03-17-2014
This method has been deprecated since 09-22-2015.
Use ProfilePalManager.getPalsByGroup()
DataList getTransactionAuditLogs(String txId)
Returns audit logs for transaction. The active user must have permission to access transaction audit logs. Otherwise null returned
Parameters:
Returns:
DataList
DataList Name: logs
DataList Fields: date, event, description, email, role, ip, browser, version
Since:
12-29-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getTransactionPalsByGroup(String group)
Returns a SystemDataView that can be used for accessing transaction pals for which the active user has createTransaction permission.
Parameters:
-
String
group
Required parameter.
Returns:
SystemDataView
DataList Name: TransactionPalsByGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
palId |
String |
|
name |
String |
|
description |
String |
|
category |
String |
|
modifiedDate |
Date |
|
active |
Boolean |
|
type |
String |
|
Since:
04-28-2011
This method has been deprecated since 09-22-2015.
Use ProfilePalManager.getTransactionPalsByGroup()
SystemDataView getTransactionPalsBySharedGroup(String shareId)
Returns a SystemDataView that can be used for accessing transaction pals for which the active user has createTransaction permission. See profile.getSharedGroups to get a shareId.
Parameters:
-
String
shareId
Required parameter.
Returns:
SystemDataView
DataList Name: TransactionPalsBySharedGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
palId |
String |
|
name |
String |
|
description |
String |
|
category |
String |
|
modifiedDate |
Date |
|
active |
Boolean |
|
type |
String |
|
Since:
06-06-2011
This method has been deprecated since 11-11-2014.
No replacement
SystemDataView getTransactionViewByGroup(String group)
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified group).
Parameters:
Returns:
SystemDataView
DataList Name: TransactionsByGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
deleteDate |
Date |
|
Since:
01-19-2009
This method has been deprecated since 12-20-2013.
Use getTransactionViewByGroup(group,palId)
SystemDataView getTransactionViewByGroup(String group, String palId)
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified group) and the specified pal. Pass null for palId to include all pals. Pass * for palId to include only those transactions that have pals within the specified group. Pass a specific pal Id to isolate to a single pal.
Parameters:
-
String
group
Required parameter.
-
String
palId
Returns:
SystemDataView
DataList Name: TransactionsByGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
deleteDate |
Date |
|
Since:
12-20-2013
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getTransactionViewByProfile(String group, String profileId)
Returns a SystemDataView that can be used for accessing transactions associated with the specified profile (a role has been assigned to the profile).
Parameters:
-
String
group
-
String
profileId
Returns:
SystemDataView
DataList Name: TransactionsByProfile
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
role |
String |
|
accessDate |
Date |
|
removeDate |
Date |
|
roleStatus |
String |
|
deleteDate |
Date |
|
Since:
12-14-2009
SystemDataView getTransactionViewByRole()
Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view returns a distinct list of transactions the active user has a role in.
Returns:
SystemDataView
DataList Name: TransactionsByRole
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
role |
String |
|
accessDate |
Date |
|
removeDate |
Date |
|
roleStatus |
String |
|
deleteDate |
Date |
|
Since:
01-19-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getTransactionViewByRoles()
Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view may include duplicate transaction entries if the user has more than one role.
Returns:
SystemDataView
DataList Name: TransactionsByRoles
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
role |
String |
|
accessDate |
Date |
|
removeDate |
String |
|
roleStatus |
String |
|
deleteDate |
Date |
|
Since:
12-09-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getTransactionViewByScheduledDelete(String group)
Returns a SystemDataView that can be used for accessing transactions that have been scheduled for deletion for the logged in users' enterprise. The active user must have the group permission 'delete transaction' for the specified group.
Parameters:
-
String
group
Required parameter.
Returns:
SystemDataView
DataList Name: ScheduledDeletedTransactions
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
deleteDate |
Date |
|
removeDate |
Date |
|
id |
String |
|
deleteStatus |
String |
|
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
SystemDataView getTransactionViewBySharedGroup(String shareId)
Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified shared group). See profile.getSharedGroups to get a shareId.
Parameters:
-
String
shareId
Required parameter.
Returns:
SystemDataView
DataList Name: TransactionsBySharedGroup
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
deleteDate |
Date |
|
Since:
01-19-2009
This method has been deprecated since 11-11-2014.
No replacement
SystemDataView getTransactionViewByUnassigned()
Returns a SystemDataView that can be used for accessing transactions of the enterprise that are not assigned to a group. The active user must have the necessary enterprise management permission.
Returns:
SystemDataView
DataList Name: TransactionsByUnassigned
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
deleteDate |
Date |
|
Since:
01-19-2009
This method has been deprecated since 09-22-2015.
No replacement. See ProfileTxManager for new APIs
SystemDataView getTransactionViewByUserRemoved()
Returns a SystemDataView that can be used for accessing transactions associated with the logged in user with roles that have been removed. The view is restricted to the active profile.
Returns:
SystemDataView
DataList Name: RemovedUserTransactions
Tag Support: No
DataList Keys/Column Name |
Column Type |
Read Only |
id |
String |
|
name |
String |
|
securedTxStatus |
String |
|
description |
String |
|
category |
String |
|
createDate |
Date |
|
modifiedDate |
Date |
|
securedTx |
Boolean |
|
test (Deprecated 03-16-2012) |
Boolean |
|
testTx |
Boolean |
|
status |
String |
|
softArchive |
Boolean |
|
systemStatus |
String |
|
webServiceStatus |
String |
|
systemRunDate |
Date |
|
systemScheduleDate |
Date |
|
palId |
String |
|
consoleControlled |
Boolean |
|
column1 |
String |
|
column2 |
String |
|
column3 |
String |
|
column4 |
String |
|
executeEndDate |
Date |
|
accessEndDate |
Date |
|
archiveEndDate |
Date |
|
archiveDate |
Date |
|
txSize |
Number |
|
role |
String |
|
accessDate |
Date |
|
removeDate |
Date |
|
roleStatus |
String |
|
deleteDate |
Date |
|
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int moveUnassignedTransactions(String[] txIds, String toGroup)
Assigns the specified unassigned transactions to the specified group. Returns the number of records modified or -1 on failure, such as if the user does not have the necessary permissions.
Parameters:
-
String[]
txIds
-
String
toGroup
Returns:
int
Since:
01-22-2010
int removeUserAccessToTransaction(String txId, String role)
Removes the specified role(s) on the given transaction from the active user. Pass * for role to remove all roles.
Parameters:
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int removeUserAccessToTransactions(String[] txIds, String role)
Removes the specified role(s) on the given transaction(s) from the active user. Pass * for role to remove all roles.
Parameters:
-
String[]
txIds
-
String
role
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
DataList repairPacket(Packet packet, String docname)
This method repairs the given transaction packet and attempts to reconnect orphaned documents that have been disconnected by bug CTP-8067. Documents with the same name are labeled doc-duplicate-index. No documents are deleted. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.
Parameters:
-
Packet
packet
Required parameter.
-
String
docname
Required parameter.
Returns:
DataList
DataList Name: documents
DataList Fields: name, docSize, repairNeeded
Since:
09-22-2015
int restoreUserAccessToTransaction(String txId, String role)
Restores the specified role(s) on the given transaction to the active user. Pass * for role to restore all roles.
Parameters:
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int restoreUserAccessToTransactions(String[] txIds, String role)
Restores the specified role(s) on the given transaction(s) to the active user. Pass * for role to restore all roles.
Parameters:
-
String[]
txIds
-
String
role
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int scheduleDeleteTransaction(String txId, String group, Date date, String datasetNames)
Schedules this transaction to be permanently deleted on the specified date or immediately if the date is in the past. If dataSetNames is not null, the related records in the identified dataSets will also be deleted. DataSetNames should be null or a comma separated list of dataSet names. This method returns 0 if the activation key does not permit deletions. The active user must have the group permission 'delete transaction' for the specified group.
Parameters:
-
String
txId
-
String
group
-
Date
date
-
String
datasetNames
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
int scheduleDeleteTransactions(String[] ids, String group, Date date, String datasetNames)
Schedules the transactions to be deleted on the specified date. See scheduleDeleteTransaction.
Parameters:
-
String[]
ids
Required parameter.
-
String
group
-
Date
date
Required parameter.
-
String
datasetNames
Maximum allowed size of parameter: 200
Returns:
int
Since:
12-14-2009
This method has been deprecated since 09-22-2015.
See ProfileTxManager
String toString()
Returns a description of this object.
Returns:
String
Since:
12-14-2009