org.enhydra.shark.api.client.wfservice
Interface SharkInterface


public interface SharkInterface

The top-most client interface for accessing shark engine. Every client application has to know about the implementation of this interface.

When client application has the instance of this interface implementation, it can call one of its methods to retrieve instances of various interfaces used for managing Shark.

Author:
Sasa Bojanic, Vladimir Puskas

Method Summary
 ActivityFilterBuilder getActivityFilterBuilder()
          Returns instance of interface for building filters for activity.
 AdminMisc getAdminMisc()
          Returns instance of interface for Miscellaneous administering.
 AdminMiscExt getAdminMiscExtension()
          Returns instance of extension interface for Miscellaneous administering.
 AssignmentFilterBuilder getAssignmentFilterBuilder()
          Returns instance of interface for building filters for assignment.
 EventAuditFilterBuilder getEventAuditFilterBuilder()
          Returns instance of interface for building filters for event audit.
 ExecutionAdministration getExecutionAdministration()
          Returns instance of interface for execution objects administering.
 ExecutionAdministrationExt getExecutionAdministrationExtension()
          Returns instance of extension interface for execution objects administering.
 PackageAdministration getPackageAdministration()
          Returns instance of interface for administering packages (XPDLs).
 java.lang.Object getPlugIn(java.lang.String name)
          Returns desired default plug-in API implementation.
 ProcessFilterBuilder getProcessFilterBuilder()
          Returns instance of interface for building filters for process.
 ProcessMgrFilterBuilder getProcessMgrFilterBuilder()
          Returns instance of interface for building filters for process manager.
 java.util.Properties getProperties()
          Returns shark configuration properties.
 ResourceFilterBuilder getResourceFilterBuilder()
          Returns instance of interface for building filters for resource.
 SharkConnection getSharkConnection()
          Returns instance of SharkConnection interface that can be used by shark user to connect to shark engine and execute assignments.
 WAPI getWAPIConnection()
          Returns instance of WfMC API interface that can be used by shark user to connect to shark engine and execute assignments.
 XPDLBrowser getXPDLBrowser()
          Returns instance of interface for browsing XPDL.
 XPILHandler getXPILHandler()
          Returns instance of interface for obtaining XPIL information.
 

Method Detail

getSharkConnection

public SharkConnection getSharkConnection()
                                   throws java.lang.Exception
Returns instance of SharkConnection interface that can be used by shark user to connect to shark engine and execute assignments.

Returns:
SharkConnection instance.
Throws:
java.lang.Exception

getWAPIConnection

public WAPI getWAPIConnection()
                       throws java.lang.Exception
Returns instance of WfMC API interface that can be used by shark user to connect to shark engine and execute assignments.

Returns:
a WAPI instance.
Throws:
java.lang.Exception

getPackageAdministration

public PackageAdministration getPackageAdministration()
                                               throws java.lang.Exception
Returns instance of interface for administering packages (XPDLs).

Throws:
java.lang.Exception

getExecutionAdministration

public ExecutionAdministration getExecutionAdministration()
                                                   throws java.lang.Exception
Returns instance of interface for execution objects administering.

Throws:
java.lang.Exception

getExecutionAdministrationExtension

public ExecutionAdministrationExt getExecutionAdministrationExtension()
                                                               throws java.lang.Exception
Returns instance of extension interface for execution objects administering.

Throws:
java.lang.Exception

getAdminMisc

public AdminMisc getAdminMisc()
                       throws java.lang.Exception
Returns instance of interface for Miscellaneous administering.

Throws:
java.lang.Exception

getAdminMiscExtension

public AdminMiscExt getAdminMiscExtension()
                                   throws java.lang.Exception
Returns instance of extension interface for Miscellaneous administering.

Throws:
java.lang.Exception

getXPDLBrowser

public XPDLBrowser getXPDLBrowser()
                           throws java.lang.Exception
Returns instance of interface for browsing XPDL.

Throws:
java.lang.Exception

getActivityFilterBuilder

public ActivityFilterBuilder getActivityFilterBuilder()
                                               throws java.lang.Exception
Returns instance of interface for building filters for activity.

Throws:
java.lang.Exception

getAssignmentFilterBuilder

public AssignmentFilterBuilder getAssignmentFilterBuilder()
                                                   throws java.lang.Exception
Returns instance of interface for building filters for assignment.

Throws:
java.lang.Exception

getEventAuditFilterBuilder

public EventAuditFilterBuilder getEventAuditFilterBuilder()
                                                   throws java.lang.Exception
Returns instance of interface for building filters for event audit.

Throws:
java.lang.Exception

getProcessFilterBuilder

public ProcessFilterBuilder getProcessFilterBuilder()
                                             throws java.lang.Exception
Returns instance of interface for building filters for process.

Throws:
java.lang.Exception

getProcessMgrFilterBuilder

public ProcessMgrFilterBuilder getProcessMgrFilterBuilder()
                                                   throws java.lang.Exception
Returns instance of interface for building filters for process manager.

Throws:
java.lang.Exception

getResourceFilterBuilder

public ResourceFilterBuilder getResourceFilterBuilder()
                                               throws java.lang.Exception
Returns instance of interface for building filters for resource.

Throws:
java.lang.Exception

getXPILHandler

public XPILHandler getXPILHandler()
                           throws java.lang.Exception
Returns instance of interface for obtaining XPIL information.

Throws:
java.lang.Exception

getProperties

public java.util.Properties getProperties()
                                   throws java.lang.Exception
Returns shark configuration properties.

Returns:
Properties object.
Throws:
java.lang.Exception

getPlugIn

public java.lang.Object getPlugIn(java.lang.String name)
                           throws java.lang.Exception
Returns desired default plug-in API implementation.

Throws:
java.lang.Exception