|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProcessMetadataService
Process metadata service APIs can be used to get information about deployed BPMN processes.
This includes:
1. listing of all projects
2. details about individual project
3. listing of all processes
4. details about individual process
5. get initiatable processes
6. get process roles
7. get the organizational unit to which a process is deployed
Method Summary | |
---|---|
java.util.List<ProcessMetadataSummary> |
getInitiatableProcesses(IBPMContext context) Gets the list of ProcessMetadataSummary objects that can be initiated in the current composite. |
java.lang.String |
getOrganizationalUnit(IBPMContext context, java.lang.String compositeDN) Get the organizational unit to which a process is deployed |
ProcessMetadataSummary |
getProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String processName) Gets the ProcessMetadataSummary object that describes the Process with the specified compositeDN and processName. |
java.util.Map<java.lang.String,java.lang.String> |
getProcessRoles(IBPMContext context, java.lang.String compositeDN) Get the process roles in a composite as a map with logical role as key and physical role as value |
ProjectMetadataSummary |
getProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String projectName) Gets the ProjectMetadataSummary object that describes the Project with the specified compositeDN and processName. |
java.util.List<ProcessMetadataSummary> |
listProcessMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) Gets a List of the ProcessMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProcessMetadataSummary> |
listProcessMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProcesses) Gets a List of the migrated ProcessMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProcessMetadataSummary> |
listProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) Gets a List of the ProcessMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProcessMetadataSummary> |
listProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProcesses) Gets a List of the migrated ProcessMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProjectMetadataSummary> |
listProjectMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) Gets a List of the ProjectMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProjectMetadataSummary> |
listProjectMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProjects) Gets a List of the ProjectMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProjectMetadataSummary> |
listProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) Gets a List of the ProjectMetadataSummary objects that match the specified keyword(s). |
java.util.List<ProjectMetadataSummary> |
listProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProjects) Gets a List of the ProjectMetadataSummary objects that match the specified keyword(s). |
Method Detail |
---|
java.util.List<ProjectMetadataSummary> listProjectMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProjects) throws ProcessMetadataServiceException
context
- The BPM contextkeyword
- The keyword to search for Project metadata summary.sortAttribute
- The attribute to sort the results by.sortOrder
- The sort order - either 'ASC' or 'DESC'includeMigratedProjects
- - boolean flag. If true, then include the migrated projects as well; otherwise notProcessMetadataServiceException
- if an error occursjava.util.List<ProjectMetadataSummary> listProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProjects) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNkeyword
- The keyword to search for Project metadata summary.sortAttribute
- The attribute to sort the results by.sortOrder
- The sort order - either 'ASC' or 'DESC'includeMigratedProjects
- - boolean flag. If true, then include the migrated projects as well; otherwise notProcessMetadataServiceException
- if an error occursjava.util.List<ProcessMetadataSummary> listProcessMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProcesses) throws ProcessMetadataServiceException
context
- The BPM contextkeyword
- The keyword to search for Process metadata summary. This keyword could be from processName, compositeName, label, organizationalUnitId.sortAttribute
- The attribute to sort the results by. The possible values are processName, compositeName, label, organizationalUnitId. If none of these values are specified, it would default to 'processName'sortOrder
- The sort order - either 'ASC' or 'DESC'includeMigratedProcesses
- - boolean flag. If true, then include the migrated processes as well; otherwise notProcessMetadataServiceException
- if an error occursjava.util.List<ProcessMetadataSummary> listProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeMigratedProcesses) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNkeyword
- The keyword to search for Process metadata summary. This keyword could be from processName, compositeName, label, organizationalUnitId.sortAttribute
- The attribute to sort the results by. The possible values are processName, compositeName, label, organizationalUnitId. If none of these values are specified, it would default to 'processName'sortOrder
- The sort order - either 'ASC' or 'DESC'includeMigratedProcesses
- - boolean flag. If true, then include the migrated process as well; otherwise notProcessMetadataServiceException
- if an error occursjava.util.List<ProjectMetadataSummary> listProjectMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) throws ProcessMetadataServiceException
context
- The BPM contextkeyword
- The keyword to search for Project metadata summary.sortAttribute
- The attribute to sort the results by.sortOrder
- The sort order - either 'ASC' or 'DESC'ProcessMetadataServiceException
- if an error occursjava.util.List<ProjectMetadataSummary> listProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNkeyword
- The keyword to search for Project metadata summary.sortAttribute
- The attribute to sort the results by.sortOrder
- The sort order - either 'ASC' or 'DESC'ProcessMetadataServiceException
- if an error occursProjectMetadataSummary getProjectMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String projectName) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNprojectName
- The name of the projectProcessMetadataServiceException
- if an error occursjava.util.List<ProcessMetadataSummary> listProcessMetadataSummary(IBPMContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) throws ProcessMetadataServiceException
context
- The BPM contextkeyword
- The keyword to search for Process metadata summary. This keyword could be from processName, compositeName, label, organizationalUnitId.sortAttribute
- The attribute to sort the results by. The possible values are processName, compositeName, label, organizationalUnitId. If none of these values are specified, it would default to 'processName'sortOrder
- The sort order - either 'ASC' or 'DESC'ProcessMetadataServiceException
- if an error occursjava.util.List<ProcessMetadataSummary> listProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNkeyword
- The keyword to search for Process metadata summary. This keyword could be from processName, compositeName, label, organizationalUnitId.sortAttribute
- The attribute to sort the results by. The possible values are processName, compositeName, label, organizationalUnitId. If none of these values are specified, it would default to 'processName'sortOrder
- The sort order - either 'ASC' or 'DESC'ProcessMetadataServiceException
- if an error occursProcessMetadataSummary getProcessMetadataSummary(IBPMContext context, java.lang.String compositeDN, java.lang.String processName) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- String the compositeDNprocessName
- The name of the processProcessMetadataServiceException
- if an error occursjava.util.List<ProcessMetadataSummary> getInitiatableProcesses(IBPMContext context) throws ProcessMetadataServiceException
context
- The BPM contextProcessMetadataServiceException
- if an error occursjava.util.Map<java.lang.String,java.lang.String> getProcessRoles(IBPMContext context, java.lang.String compositeDN) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- The compositeDNProcessMetadataServiceException
- if an error occursjava.lang.String getOrganizationalUnit(IBPMContext context, java.lang.String compositeDN) throws ProcessMetadataServiceException
context
- The BPM contextcompositeDN
- The compositeDN of the processProcessMetadataServiceException
- if an error occurs
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |