com.timestock.tess.webservices.api
Interface IConfigurationDataOutService

All Superinterfaces:
java.rmi.Remote

public interface IConfigurationDataOutService
extends java.rmi.Remote

This web service provides methods to fetch CEM configuration data objects.


Method Summary
 DApplicationDefinition[] getAllApplicationDefinitions()
          Gets all Application Definitions from the database.
 DBusinessProcessDefinition[] getAllBusinessProcessDefinitions()
          Gets all Business Process Definitions from the database.
 DUserGroup[] getAllUserGroups()
          Gets all the user groups from the database.
 DUser[] getAllUsers()
          Gets all the users from the database.
 DBusinessProcessDefinition getBusinessProcessDefinitionById(long id)
          Gets a specified Business Process Definition from the database.
 DBusinessProcessDefinition getBusinessProcessDefinitionByName(java.lang.String name)
          Gets a specified Business Process Definition from the database.
 DBusinessProcessDefinition[] getBusinessProcessDefinitionsByAppId(long applicationId)
          Get the Business Process Definitions from the database belonging to the given application
 DBusinessTransactionDefinition[] getBusinessTransactionDefinitions(long businessProcessDefinitionId)
          Gets all Business Transaction Definitions for a specified Business Process Definition.
 DBusinessTransactionDefinition[] getBusinessTransactionDefinitions(java.lang.String businessProcessDefinitionName)
          Gets all Business Transaction Definitions for a specified Business Process Definition.
 DBusinessTransactionDefinition[] getEnabledBusinessTransactionDefinitions(long businessProcessDefinitionId)
          Gets all enabled Business Transaction Definitions for a specified Business Process Definition.
 DBusinessProcessDefinition[] getFilteredBusinessProcessDefinitions(java.lang.String regex)
          Gets filtered Business Process Definitions from the database.
 DBusinessTransactionDefinition[] getFilteredBusinessTransactionDefinitions(long businessProcessDefinitionId, java.lang.String regex)
          Gets filtered Business Transaction Definitions for a specified Business Process Definition.
 DBusinessTransactionDefinition[] getFilteredEnabledBusinessTransactionDefinitions(long businessProcessDefinitionId, java.lang.String regex)
          Gets filtered enabled Business Transaction Definitions for a specified Business Process Definition.
 DUserGroup[] getFilteredUserGroups(java.lang.String regularExpression)
          Gets all the user groups from the database that match the passed regular expression.
 DUser getUserById(long id)
          Gets a specified user from the database.
 DUser getUserByName(java.lang.String name)
          Gets a specified user from the database.
 DUserGroup getUserGroupById(long id)
          Gets a specified user group from the database.
 DUserGroup getUserGroupByName(java.lang.String name)
          Gets a specified user group from the database.
 DUser[] getUsersForUserGroup(long userGroupId)
          Gets all users in a specified user group.
 DUser[] getUsersForUserGroup(java.lang.String userGroupName)
          Gets all users in a specified user group.
 

Method Detail

getAllUsers

DUser[] getAllUsers()
                    throws java.rmi.RemoteException,
                           CEMWebServicesException
Gets all the users from the database.

Returns:
Array of user objects
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getUserById

DUser getUserById(long id)
                  throws java.rmi.RemoteException,
                         CEMWebServicesException
Gets a specified user from the database. Throws exception if specified user is not found.

Parameters:
id - the user id
Returns:
Specified user object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getUserByName

DUser getUserByName(java.lang.String name)
                    throws java.rmi.RemoteException,
                           CEMWebServicesException
Gets a specified user from the database. Throws exception if specified user is not found.

Parameters:
name - the user name
Returns:
Specified user object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getAllUserGroups

DUserGroup[] getAllUserGroups()
                              throws java.rmi.RemoteException,
                                     CEMWebServicesException
Gets all the user groups from the database.

Returns:
Array of user group objects
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getFilteredUserGroups

DUserGroup[] getFilteredUserGroups(java.lang.String regularExpression)
                                   throws java.rmi.RemoteException,
                                          CEMWebServicesException
Gets all the user groups from the database that match the passed regular expression.

Parameters:
String - regularExpression
Returns:
Array of user group objects that match regularExpression
Throws:
CEMWebServicesException
java.rmi.RemoteException

getUserGroupById

DUserGroup getUserGroupById(long id)
                            throws java.rmi.RemoteException,
                                   CEMWebServicesException
Gets a specified user group from the database. Throws exception if specified user group is not found.

Parameters:
id - the user group id
Returns:
Specified user group object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getUserGroupByName

DUserGroup getUserGroupByName(java.lang.String name)
                              throws java.rmi.RemoteException,
                                     CEMWebServicesException
Gets a specified user group from the database. Throws exception if specified user group is not found.

Parameters:
name - the user group name
Returns:
Specified user group object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getUsersForUserGroup

DUser[] getUsersForUserGroup(long userGroupId)
                             throws java.rmi.RemoteException,
                                    CEMWebServicesException
Gets all users in a specified user group. Throws exception if specified user group is not found.

Parameters:
userGroupId - the user group id
Returns:
Array of users
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getUsersForUserGroup

DUser[] getUsersForUserGroup(java.lang.String userGroupName)
                             throws java.rmi.RemoteException,
                                    CEMWebServicesException
Gets all users in a specified user group. Throws exception if specified user group is not found.

Parameters:
userGroupName - the user group name
Returns:
Array of users
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getAllApplicationDefinitions

DApplicationDefinition[] getAllApplicationDefinitions()
                                                      throws java.rmi.RemoteException,
                                                             CEMWebServicesException
Gets all Application Definitions from the database.

Returns:
Array of Application Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.5.3

getBusinessProcessDefinitionsByAppId

DBusinessProcessDefinition[] getBusinessProcessDefinitionsByAppId(long applicationId)
                                                                  throws java.rmi.RemoteException,
                                                                         CEMWebServicesException
Get the Business Process Definitions from the database belonging to the given application

Parameters:
applicationId - The ID of the application
Returns:
Array of Business Process Definitions
Throws:
java.rmi.RemoteException
CEMWebServicesException
Since:
4.5.3

getAllBusinessProcessDefinitions

DBusinessProcessDefinition[] getAllBusinessProcessDefinitions()
                                                              throws java.rmi.RemoteException,
                                                                     CEMWebServicesException
Gets all Business Process Definitions from the database.

Returns:
Array of Business Process Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getFilteredBusinessProcessDefinitions

DBusinessProcessDefinition[] getFilteredBusinessProcessDefinitions(java.lang.String regex)
                                                                   throws java.rmi.RemoteException,
                                                                          CEMWebServicesException
Gets filtered Business Process Definitions from the database.

Parameters:
regex - String regular expression
Returns:
Array of Filtered Business Process Definitions that match regex
Throws:
CEMWebServicesException
java.rmi.RemoteException

getBusinessProcessDefinitionById

DBusinessProcessDefinition getBusinessProcessDefinitionById(long id)
                                                            throws java.rmi.RemoteException,
                                                                   CEMWebServicesException
Gets a specified Business Process Definition from the database. Throws exception if specified Business Process Definition is not found.

Parameters:
id - the Business Process Definition id
Returns:
Specified Business Process Definition object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getBusinessProcessDefinitionByName

DBusinessProcessDefinition getBusinessProcessDefinitionByName(java.lang.String name)
                                                              throws java.rmi.RemoteException,
                                                                     CEMWebServicesException
Gets a specified Business Process Definition from the database. Throws exception if specified Business Process Definition is not found.

Parameters:
name - the Business Process Definition name
Returns:
Specified Business Process Definition object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getBusinessTransactionDefinitions

DBusinessTransactionDefinition[] getBusinessTransactionDefinitions(long businessProcessDefinitionId)
                                                                   throws java.rmi.RemoteException,
                                                                          CEMWebServicesException
Gets all Business Transaction Definitions for a specified Business Process Definition. Throws exception if specified Business Process Definition is not found.

Parameters:
businessProcessDefinitionId - the Business Process Definition id
Returns:
Array of Business Transaction Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getEnabledBusinessTransactionDefinitions

DBusinessTransactionDefinition[] getEnabledBusinessTransactionDefinitions(long businessProcessDefinitionId)
                                                                          throws java.rmi.RemoteException,
                                                                                 CEMWebServicesException
Gets all enabled Business Transaction Definitions for a specified Business Process Definition. Throws exception if specified Business Process Definition is not found.

Parameters:
businessProcessDefinitionId - the Business Process Definition id
Returns:
Array of Business Transaction Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getFilteredBusinessTransactionDefinitions

DBusinessTransactionDefinition[] getFilteredBusinessTransactionDefinitions(long businessProcessDefinitionId,
                                                                           java.lang.String regex)
                                                                           throws java.rmi.RemoteException,
                                                                                  CEMWebServicesException
Gets filtered Business Transaction Definitions for a specified Business Process Definition. Throws exception if specified Business Process Definition is not found.

Parameters:
businessProcessDefinitionId - the Business Process Definition id
regex - regular expressing
Returns:
Array of Business Transaction Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException

getFilteredEnabledBusinessTransactionDefinitions

DBusinessTransactionDefinition[] getFilteredEnabledBusinessTransactionDefinitions(long businessProcessDefinitionId,
                                                                                  java.lang.String regex)
                                                                                  throws java.rmi.RemoteException,
                                                                                         CEMWebServicesException
Gets filtered enabled Business Transaction Definitions for a specified Business Process Definition. Throws exception if specified Business Process Definition is not found.

Parameters:
businessProcessDefinitionId - the Business Process Definition id
regex - regular expressing
Returns:
Array of Business Transaction Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException

getBusinessTransactionDefinitions

DBusinessTransactionDefinition[] getBusinessTransactionDefinitions(java.lang.String businessProcessDefinitionName)
                                                                   throws java.rmi.RemoteException,
                                                                          CEMWebServicesException
Gets all Business Transaction Definitions for a specified Business Process Definition. Throws exception if specified Business Process Definition is not found.

Parameters:
businessProcessDefinitionName - the Business Process Definition name
Returns:
Array of Business Transaction Definitions
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0