com.ibm.tws.zconn.plan
Interface ZConnPlan


public interface ZConnPlan

Remote interface for Enterprise Bean: ZConnPlan. This interface contains the methods exposed by the z/OS Plan Connector. Not all the methods of this interface are valid for z/OS Connector. In this case, when invoked they throws an OperationNotSupportedException.


Method Summary
 Identifier addJobInstance(Identifier jobId, Identifier workstationId, java.lang.String alias, Context context)
          This method Adds a Job Instance.
 Identifier addJobInstance(JobInPlan job, Context context)
          Add the input job instance to the current Plan.
 void addJobInstanceDependencies(Identifier jobId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List internalDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Add the specified dependencies to the specified job.
 Identifier addJobInstanceIntoJobStreamInstance(Identifier jobId, Identifier jobStreamId, java.lang.String alias, Context context)
          This operation is not supported in z/OS environment.
 void addJobInstanceSuccessors(Identifier jobId, java.util.List internalDeps, java.util.List externalDeps, Context context)
          Add the specified successor dependencies to the specified job.
 java.util.List addJobStreamInstance(Identifier jobStreamId, java.util.Date inputArrivalTime, java.lang.String alias, Context context)
          This method adds a Job Stream to the current Plan.
 java.util.List addJobStreamInstance(JobStreamInPlan jobStream, Context context)
          Add the input job stream instance to the current Plan.
 java.util.List addJobStreamInstance(java.lang.String name, java.util.Date startTime, java.util.Date deadlineTime, int priority, java.lang.String description, java.lang.String group, java.lang.String owner, java.lang.String ownerDescription, java.lang.String variableTable, java.lang.String authorityGroup, boolean holdAll, DependenciesResolutionOption dependeciesResolution, Context context)
          Add the job stream instance.
 void addJobStreamInstanceDependencies(Identifier jobStreamId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Add the specified dependencies to the specified job stream.
 void beginJobJCL(Identifier id, Context context)
          Start the modify session for the JCL of the job identified by the given id.
 void beginJobRestartCleanup(Identifier jobId, RestartCleanupOptions options, Context context)
          Execute Restart and Cleanup for the requested job instance.
 void beginJobRestartCleanupWithAR(Identifier jobId, RestartCleanupOptions options, Context context)
          Starts the Restart and Cleanup (with AR) for the requested job instance.
 void beginModifyPlanObject(java.lang.Class cl, Identifier id, Context context)
          Start the modify session for the TWSObject object identified by the given id.
 void cancelJobInstance(Identifier jobId, boolean pending, Context context)
          Cancel the specified job.
 void cancelJobStreamInstance(Identifier jobStreamId, boolean pending, Context context)
          Cancel the specified job stream.
 void commitJobJCL(Identifier jobId, Context context)
          Commit the JCL modification done on the job identified by the given id.
 void commitJobRestartAndCleanup(java.lang.Class cl, Identifier id, Context context)
          Commit the restartAndCleanup modification done on the TWSObject object identified by the given id.
 void commitModifyPlanObject(java.lang.Class cl, Identifier id, Context context)
          Commit the modification to the TWSObject object identified by the given id.
 void completeJobStreamInstance(Identifier id, Context context)
          Complete the job stream instance to wait.
 void confirmJobInstance(Identifier jobId, FlowNodeInternalStatusType status, Context context)
          Confirm the specified job with the specified status.
 byte[] connectToHostCpu(Identifier workstationId, java.lang.String connectionString, byte[] command, Context context)
          Return the byte array result of the invocation of the access method associated to the input Workstation.
 java.util.List countPlanObject(java.lang.Class cl, QueryFilter filter, java.lang.String groupField, Context context)
          This method returns aggregate statistics on plan objects.
 Identifier createPlan(SymphonyInPlanKey key, java.util.Date startTime, long timeExtension, Context context)
          This method is used to create a Trial or a Forecast plan.
 Identifier createPlanExtension(SymphonyInPlanKey key, long timeExtension, Context context)
          This method is used to create a Trial Plan extension starting from the current Plan.
 void executeJobAutomaticRecovery(Identifier jobId, Context context)
          Execute the automatic recovery for the job specified in the jobId.
 void executeJobInstance(Identifier jobId, Context context)
          Execute the job instance specified in the jobId.
 void executeJobRestartCleanup(Identifier jobId, java.lang.String errorCode, java.lang.String userData, java.lang.String reason, Context context)
          Execute Restart and Cleanup for the requested job instance.
 java.util.List getCriticalPath(Identifier jobId, Context context)
          Get the critical path jobs list.
 EngineInformation getEngineInformation(Context context)
          Returns the engine information taken from the current Plan.
 java.util.List getJobCleanupResult(Identifier jobId, Context context)
          Returns Cleanup result for the requested job instance.
 java.util.List getJobDataSets(Identifier jobId, Context context)
          Returns the data set list for the requested job instance.
 DataSetsListResult getJobDataSetsWithAutomaticRecovery(Identifier jobId, Context context)
          Returns the data set list for the requested job instance and the suggested restart step.
 java.util.List getJobInstanceNonCompletedPredecessors(Identifier jobId, Context context)
          Get the non completed internal and external predecessors of a job.
 java.util.List getJobInstanceNonWaitingSuccessors(Identifier jobId, Context context)
          Get the non waiting internal and external successors of a job.
 OperatorInstructionInPlan getJobInstanceOperatorInstructions(Identifier jobId, Context context)
          Get the operator instructions associated to the specifid job in plan
 GetJobOutputResult getJobInstanceOutput(GetJobOutputContext context)
          Return output in bunch, after the first one, of a JobInPlan.
 GetJobOutputResult getJobInstanceOutput(Identifier jobId, int lines, Context context)
          Return the first bunch of a JobInPlan output.
 java.util.List getJobInstancePredecessors(Identifier jobId, Context context)
          Get the internal and external predecessors of a job.
 GetJobOutputResult getJobInstanceRecoveryOutput(GetJobOutputContext context)
          Return the requested recovery job output informations
 GetJobOutputResult getJobInstanceRecoveryOutput(Identifier jobId, int numOfLinesToRead, Context context)
          Return the requested recovery job output informations
 java.util.List getJobInstanceSuccessors(Identifier jobId, Context context)
          Get the internal and external successors of a job.
 JobControlLanguage getJobJCL(Identifier jobId, boolean isForRestartAndCleanup, Context context)
          Return the requested job JCL
 java.util.List getJobJCLPromptableVariableList(Identifier jobId, Context context)
          Return the requested job JCL promptable variable list.
 java.util.List getJobRestartSteps(Identifier jobId, java.util.List stepList, boolean[] stepListCheck, Context context)
          Returns the restart step list and if is checked for the requested job instance.
 TWSObject getPlanObject(java.lang.Class cl, Identifier id, Context context)
          This method return the Plan Object of the specified class with the given Identifier passed in input
 void holdJobInstance(Identifier jobId, Context context)
          Holds the specified job.
 void holdJobStreamInstance(Identifier jobStreamId, Context context)
          Holds the specified job stream.
 void holdJobStreamInstanceJobs(Identifier id, boolean holdAll, Context context)
          Hold all the job stream jobs.
 void killFTAJobInstance(Identifier jobId, Context context)
          Kill the FTA job instance specified in the jobId.
 void killJobInstance(Identifier jobId, Context context)
          Kill the specified job.
 void killRecoveryJobInstance(Identifier jobId, Context context)
          Kill the recovery job instance specified in the jobId.
 void linkDomainWorkstation(Identifier id, Context context)
          This method links the domain workstation.
 void linkWorkstation(Identifier id, Context context)
          Links the Workstation Instance.
 JobInPlan makeJobInPlan(Identifier jobId, Identifier workstationId, java.lang.String alias, Context context)
          This method generates a JobInPlan object starting from a JobDefinition taken from the database.
 JobInPlan makeJobInPlanIntoJobStreamInstance(Identifier jobId, Identifier jobStreamId, java.lang.String alias, Context context)
          This method generates a JobInPlan object starting from a JobDefinition taken from the database.
 JobStreamInPlan makeJobStreamInPlan(Identifier jobStreamId, java.util.Date inputArrivalTime, java.lang.String alias, Context context)
          This operation is not supported in z/OS environment.
 void modifyJobInstanceDependencies(Identifier jobId, java.util.List removeResourceDeps, java.util.List removeInternalDeps, java.util.List removeExternalDeps, java.util.List removeInternalSucc, java.util.List removeExternalSucc, java.util.List addResourceDeps, java.util.List addInternalDeps, java.util.List addExternalDeps, java.util.List addInternalSucc, java.util.List addExternalSucc, Context context)
          Modify the specified dependences of a job instance specified by the jobId.
 void monitorAllJobsInStreamInstance(Identifier jobStreamId, boolean monitor, Context context)
          Set/deset the monitor flag on all the job instance part of the specified job stream instance.
 void nopJobInstance(Identifier jobId, Context context)
          NOP the job instance specified in the jobId.
 QueryResult queryJobInstanceResourceUsage(QueryFilter filter, int howMany, Context context)
          Returns the list of Job In plan objects that are holding or waiting on the resource specified in the filter
 QueryResult queryNext(QueryPlanContext queryContext)
          Return a list of objects according with the Filter present in the context.
 QueryResult queryNextJobInstanceResourceUsage(QueryPlanContext queryContext)
          Return a list of JobInPlan Objects holding or waiting ona given resource according with the query context passed in input This list is contained in the QueryResult object
 QueryResult queryPlanObject(java.lang.Class cl, QueryFilter filter, int howMany, Context context)
          Return a list of object according with the Filter passed in input.
 void releaseAllJobInstanceDependencies(Identifier jobId, Context context)
          Release all the dependencies from the specified job.
 void releaseAllJobStreamInstanceDependencies(Identifier jobStreamId, Context context)
          Release all the dependencies from the specified job stream.
 void releaseJobInstance(Identifier jobId, Context context)
          Release the specified job.
 void releaseJobInstanceDependencies(Identifier jobId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List internalDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Release the specified dependencies from the specified job.
 void releaseJobStreamInstance(Identifier jobStreamId, Context context)
          Release the specified job stream.
 void releaseJobStreamInstanceDependencies(Identifier jobStreamId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Release the specified dependencies from the specified job stream.
 void removeJobInstanceDependencies(Identifier jobId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List internalDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Remove the specified dependencies from the specified job.
 void removeJobInstanceSuccessors(Identifier jobId, java.util.List internalDeps, java.util.List externalDeps, Context context)
          Remove the specified successors from the job identified by jobId
 void removeJobStreamInstanceDependencies(Identifier jobStreamId, java.util.List fileDeps, java.util.List resourceDeps, java.util.List promptDeps, java.util.List externalDeps, java.util.List internetworkDeps, Context context)
          Remove the specified dependencies from the specified job stream.
 void replyPrompt(Identifier id, boolean answer, Context context)
          Reply 'YES' (true) or 'NO' (false) to the sopecified prompt.
 void rerunJobInstance(Identifier jobId, RerunDetails details, Context context)
          Rerun the specified job.
 void rollbackJobJCL(Identifier jobId, boolean forJCLPREP, Context context)
          Rollback the JCL modification done on the job identified by the given id.
 void rollbackJobRestartAndCleanup(java.lang.Class cl, Identifier id, Context context)
          Rollback the restartAndCleanup modification done on the TWSObject object identified by the given id.
 void rollbackModifyPlanObject(java.lang.Class cl, Identifier id, Context context)
          rollback the modification to the TWSObject object identified by the given id.
 void setJobDataSets(Identifier jobId, java.util.List dataSets, Context context)
          Sets the data set list for the requested job instance.
 void setJobInstance(JobInPlan job, Context context)
          Change properties of the specified job.
 void setJobInstanceStatus(Identifier jobId, FlowNodeInternalStatusType status, java.lang.String errorCode, Context context)
          Set the status of the job instance specified in the jobId.
 void setJobJCL(Identifier jobId, JobControlLanguage jcl, boolean isForRestartCleanup, Context context)
          Set the requested job JCL
 void setJobJCLPromptableVariableList(Identifier jobId, java.util.List variables, Context context)
          Set the requested job JCL promptable variable list.
 void setJobRestartSteps(Identifier jobId, java.util.List stepList, Context context)
          Sets the restart step list for the requested job instance.
 Identifier setJobStreamInstance(JobStreamInPlan jobStream, Context context)
          Change properties of the specified job stream.
 void setResourceInstance(ResourceInPlan resource, Context context)
          Change properties of the specified resource.
 void setToWaitJobStreamInstance(Identifier id, Context context)
          Set the job stream instance to wait.
 void setWholeJobInstance(JobInPlan job, boolean changeStatus, java.util.List removeResourceDeps, java.util.List removeInternalDeps, java.util.List removeExternalDeps, java.util.List removeInternalSucc, java.util.List removeExternalSucc, java.util.List addResourceDeps, java.util.List addInternalDeps, java.util.List addExternalDeps, java.util.List addInternalSucc, java.util.List addExternalSucc, Context context)
          Change properties and dependencies of the specified job in a single atomic action
 void setWindowsUserPassword(WindowsUserInPlan winUser, Context context)
          Sets the password for the specified user.
 void setWorkstationFence(Identifier id, int fence, Context context)
          Sets the Workstation Instance new Fence.
 void setWorkstationInstance(WorkstationInPlan workstation, Context context)
          Set the values for the input Workstation instance.
 void setWorkstationLimit(Identifier id, int limit, Context context)
          Sets the Workstation Instance new Limit.
 void setWorkstationStatus(Identifier id, Context context, WorkstationStatus status, WorkstationOperationOption options, WorkstationInPlanKey alternateWorkstation)
          Set the status for the input Workstation instance.
 JobControlLanguage solveJobJCLNoPromptableVariableList(Identifier jobId, Context context)
          Return the requested job JCL variable list.
 void startDomainWorkstation(Identifier id, Context context)
          This method starts the domain workstation.
 void startWorkstation(Identifier id, boolean manager, Context context)
          Starts the Workstation Instance.
 void stopDomainWorkstation(Identifier id, Context context)
          This method stops the domain workstation.
 void stopWorkstation(Identifier id, Context context)
          Stops the Workstation Instance.
 void switchDomainManager(Identifier id, Identifier newMgr, Context context)
          This method changes the Domain manager of a given domain.
 void unlinkDomainWorkstation(Identifier id, Context context)
          This method unlinks the domain workstation.
 void unlinkWorkstation(Identifier id, Context context)
          Unlinks the Workstation Instance.
 void unNopJobInstance(Identifier jobId, Context context)
          Un NOP the job instance specified in the jobId.
 

Method Detail

startDomainWorkstation

public void startDomainWorkstation(Identifier id,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
This method starts the domain workstation. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the DomainInPlan to be started.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

stopDomainWorkstation

public void stopDomainWorkstation(Identifier id,
                                  Context context)
                           throws ConnException,
                                  ConnLockingException,
                                  ConnNotFoundException,
                                  ConnSecurityException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  java.rmi.RemoteException
This method stops the domain workstation. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the DomainInPlan to be stopped.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

linkDomainWorkstation

public void linkDomainWorkstation(Identifier id,
                                  Context context)
                           throws ConnException,
                                  ConnLockingException,
                                  ConnNotFoundException,
                                  ConnSecurityException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  java.rmi.RemoteException
This method links the domain workstation. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the DomainInPlan to be linked.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

unlinkDomainWorkstation

public void unlinkDomainWorkstation(Identifier id,
                                    Context context)
                             throws ConnException,
                                    ConnLockingException,
                                    ConnNotFoundException,
                                    ConnSecurityException,
                                    ConnTransportException,
                                    ConnValidationException,
                                    java.rmi.RemoteException
This method unlinks the domain workstation. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the DomainInPlan to be unlinked.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

switchDomainManager

public void switchDomainManager(Identifier id,
                                Identifier newMgr,
                                Context context)
                         throws ConnException,
                                ConnLockingException,
                                ConnNotFoundException,
                                ConnSecurityException,
                                ConnTransportException,
                                ConnValidationException,
                                java.rmi.RemoteException
This method changes the Domain manager of a given domain. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the DomainInPlan to switch.
newMgr - The identifier of the new WorkstationInPlan domain manager.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

startWorkstation

public void startWorkstation(Identifier id,
                             boolean manager,
                             Context context)
                      throws ConnException,
                             ConnLockingException,
                             ConnNotFoundException,
                             ConnSecurityException,
                             ConnTransportException,
                             ConnValidationException,
                             java.rmi.RemoteException
Starts the Workstation Instance. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the WorkstationInPlan to start
manager - true if the Workstation should start as manager, false otherwise.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

stopWorkstation

public void stopWorkstation(Identifier id,
                            Context context)
                     throws ConnException,
                            ConnLockingException,
                            ConnNotFoundException,
                            ConnSecurityException,
                            ConnTransportException,
                            ConnValidationException,
                            java.rmi.RemoteException
Stops the Workstation Instance. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the WorkstationInPlan to stop
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

linkWorkstation

public void linkWorkstation(Identifier id,
                            Context context)
                     throws ConnException,
                            ConnLockingException,
                            ConnNotFoundException,
                            ConnSecurityException,
                            ConnTransportException,
                            ConnValidationException,
                            java.rmi.RemoteException
Links the Workstation Instance.

Parameters:
id - The identifier of the WorkstationInPlan to link
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

unlinkWorkstation

public void unlinkWorkstation(Identifier id,
                              Context context)
                       throws ConnException,
                              ConnLockingException,
                              ConnNotFoundException,
                              ConnSecurityException,
                              ConnTransportException,
                              ConnValidationException,
                              java.rmi.RemoteException
Unlinks the Workstation Instance.

Parameters:
id - The identifier of the WorkstationInPlan to unlink
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setWorkstationLimit

public void setWorkstationLimit(Identifier id,
                                int limit,
                                Context context)
                         throws ConnException,
                                ConnLockingException,
                                ConnNotFoundException,
                                ConnSecurityException,
                                ConnTransportException,
                                ConnValidationException,
                                java.rmi.RemoteException
Sets the Workstation Instance new Limit. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the WorkstationInPlan on which change the limit.
limit - the new limit value. Valid values are between -1 and 1024.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setWorkstationFence

public void setWorkstationFence(Identifier id,
                                int fence,
                                Context context)
                         throws ConnException,
                                ConnLockingException,
                                ConnNotFoundException,
                                ConnSecurityException,
                                ConnTransportException,
                                ConnValidationException,
                                java.rmi.RemoteException
Sets the Workstation Instance new Fence. This operation is not supported in z/OS environment.

Parameters:
id - The identifier of the WorkstationInPlan on which change the limit.
fence - the new limit value. Valid values are between 0 and 101.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setWindowsUserPassword

public void setWindowsUserPassword(WindowsUserInPlan winUser,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
Sets the password for the specified user. This operation is not supported in z/OS environment.

Parameters:
winUser - The windows user object that contains the Identifier, the user name and/or the password.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

getPlanObject

public TWSObject getPlanObject(java.lang.Class cl,
                               Identifier id,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
This method return the Plan Object of the specified class with the given Identifier passed in input

Parameters:
cl - The Class of the object to be retrieved.
id - The Identifier of the object to be retrieved.
context - The user context, or null if a default context is to be used.
Returns:
the requested TWSObject. Obviously a cast by the caller is required.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

queryPlanObject

public QueryResult queryPlanObject(java.lang.Class cl,
                                   QueryFilter filter,
                                   int howMany,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
Return a list of object according with the Filter passed in input. This method should be used only for the first call. For the next calls use the method queryNext. To simplify the iteration on the returned bunches it is recommended to use the ConnPlanIterator.

Parameters:
cl - The Class of the headers to be retrieved.
filter - the QueryFilter object that contains the filters to be used during the query.
howMany - the number of headers to be returned in each call.
context - The user context, or null if a default context is to be used.
Returns:
the QueryResult, containing the a bunch (List) of object (eventually empty if the query is ended) and a QueryPlanContext, needed for the next query.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

queryNext

public QueryResult queryNext(QueryPlanContext queryContext)
                      throws ConnException,
                             ConnLockingException,
                             ConnNotFoundException,
                             ConnSecurityException,
                             ConnTransportException,
                             ConnValidationException,
                             java.rmi.RemoteException
Return a list of objects according with the Filter present in the context. This method should be used only for subsequent call, not for the first one.

Parameters:
queryContext - The context present in the QueryResult returned in the previous call.
Returns:
the QueryResult, containing the a bunch (List) of object.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

releaseJobInstance

public void releaseJobInstance(Identifier jobId,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Release the specified job.

Parameters:
jobId - The identifier of the JobInPlan to be released
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

holdJobInstance

public void holdJobInstance(Identifier jobId,
                            Context context)
                     throws ConnException,
                            ConnLockingException,
                            ConnNotFoundException,
                            ConnSecurityException,
                            ConnTransportException,
                            ConnValidationException,
                            java.rmi.RemoteException
Holds the specified job.

Parameters:
jobId - The identifier of the JobInPlan to hold
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

confirmJobInstance

public void confirmJobInstance(Identifier jobId,
                               FlowNodeInternalStatusType status,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Confirm the specified job with the specified status. This operation is not supported in z/OS environment.

Parameters:
jobId - The identifier of the JobInPlan to confirm
status - The new status of the job.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

killJobInstance

public void killJobInstance(Identifier jobId,
                            Context context)
                     throws ConnException,
                            ConnLockingException,
                            ConnNotFoundException,
                            ConnSecurityException,
                            ConnTransportException,
                            ConnValidationException,
                            java.rmi.RemoteException
Kill the specified job. This operation is not supported in z/OS environment.

Parameters:
jobId - The identifier of the JobInPlan to kill
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

rerunJobInstance

public void rerunJobInstance(Identifier jobId,
                             RerunDetails details,
                             Context context)
                      throws ConnException,
                             ConnLockingException,
                             ConnNotFoundException,
                             ConnSecurityException,
                             ConnTransportException,
                             ConnValidationException,
                             java.rmi.RemoteException
Rerun the specified job. This operation is not supported in z/OS environment.

Parameters:
jobId - The identifier of the JobInPlan to rerun
details - An utility object, containing the information needed to rerun the job.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a master.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

cancelJobInstance

public void cancelJobInstance(Identifier jobId,
                              boolean pending,
                              Context context)
                       throws ConnException,
                              ConnLockingException,
                              ConnNotFoundException,
                              ConnSecurityException,
                              ConnTransportException,
                              ConnValidationException,
                              java.rmi.RemoteException
Cancel the specified job.

Parameters:
jobId - The identifier of the JobInPlan to cancel
pending - True if this operation is a cancel-pending, false otherwise.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

releaseAllJobInstanceDependencies

public void releaseAllJobInstanceDependencies(Identifier jobId,
                                              Context context)
                                       throws ConnException,
                                              ConnLockingException,
                                              ConnNotFoundException,
                                              ConnSecurityException,
                                              ConnTransportException,
                                              ConnValidationException,
                                              java.rmi.RemoteException
Release all the dependencies from the specified job. This operation is not supported in z/OS environment.

Parameters:
jobId - The identifier of the JobInPlan from which all the dependencies should be released.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

releaseJobInstanceDependencies

public void releaseJobInstanceDependencies(Identifier jobId,
                                           java.util.List fileDeps,
                                           java.util.List resourceDeps,
                                           java.util.List promptDeps,
                                           java.util.List internalDeps,
                                           java.util.List externalDeps,
                                           java.util.List internetworkDeps,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           java.rmi.RemoteException
Release the specified dependencies from the specified job. This operation is not supported in z/OS environment.

Parameters:
jobId - The identifier of the JobInPlan from which the specified dependencies should be released.
fileDeps - A List of FileDependencyInPlan objects to be released.
resourceDeps - A List of ResourceDependencyInPlan objects to be released.
promptDeps - A List of PromptDependencyInPlan objects to be released.
internalDeps - A List of InternalDependencyInPlan objects to be released.
externalDeps - A List of ExternalDependencyInPlan objects to be released.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be released.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

removeJobInstanceDependencies

public void removeJobInstanceDependencies(Identifier jobId,
                                          java.util.List fileDeps,
                                          java.util.List resourceDeps,
                                          java.util.List promptDeps,
                                          java.util.List internalDeps,
                                          java.util.List externalDeps,
                                          java.util.List internetworkDeps,
                                          Context context)
                                   throws ConnException,
                                          ConnLockingException,
                                          ConnNotFoundException,
                                          ConnSecurityException,
                                          ConnTransportException,
                                          ConnValidationException,
                                          java.rmi.RemoteException
Remove the specified dependencies from the specified job.

Parameters:
jobId - The identifier of the JobInPlan from which the specified dependencies should be removed.
fileDeps - A List of FileDependencyInPlan objects to be removed.
resourceDeps - A List of ResourceDependencyInPlan objects to be removed.
promptDeps - A List of PromptDependencyInPlan objects to be removed.
internalDeps - A List of InternalDependencyInPlan objects to be removed.
externalDeps - A List of ExternalDependencyInPlan objects to be removed.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be removed.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

addJobInstanceDependencies

public void addJobInstanceDependencies(Identifier jobId,
                                       java.util.List fileDeps,
                                       java.util.List resourceDeps,
                                       java.util.List promptDeps,
                                       java.util.List internalDeps,
                                       java.util.List externalDeps,
                                       java.util.List internetworkDeps,
                                       Context context)
                                throws ConnException,
                                       ConnLockingException,
                                       ConnNotFoundException,
                                       ConnSecurityException,
                                       ConnTransportException,
                                       ConnValidationException,
                                       java.rmi.RemoteException
Add the specified dependencies to the specified job.

Parameters:
jobId - The identifier of the JobInPlan from which the specified dependencies should be added.
fileDeps - A List of FileDependencyInPlan objects to be added.
resourceDeps - A List of ResourceDependencyInPlan objects to be added.
promptDeps - A List of PromptDependencyInPlan objects to be added.
internalDeps - A List of InternalDependencyInPlan objects to be added.
externalDeps - A List of ExternalDependencyInPlan objects to be added.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be added.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

addJobInstance

public Identifier addJobInstance(JobInPlan job,
                                 Context context)
                          throws ConnException,
                                 ConnLockingException,
                                 ConnNotFoundException,
                                 ConnSecurityException,
                                 ConnTransportException,
                                 ConnValidationException,
                                 java.rmi.RemoteException
Add the input job instance to the current Plan. This operation is not supported in z/OS environment.

Parameters:
job - The JobInPlan to be added.
context - The user context, or null if a default context is to be used.
Returns:
The Identifier of the added Job
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A remote Exception occurred

addJobStreamInstance

public java.util.List addJobStreamInstance(JobStreamInPlan jobStream,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           ConnEngineNotMasterException,
                                           java.rmi.RemoteException
Add the input job stream instance to the current Plan. This operation is not supported in z/OS environment.

Parameters:
jobStream - The JobStreamInPlan to be added.
context - The user context, or null if a default context is to be used.
Returns:
List the list the Identifier of the Job Streams added to the Plan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.
See Also:
JobStreamInPlan

addJobStreamInstance

public java.util.List addJobStreamInstance(java.lang.String name,
                                           java.util.Date startTime,
                                           java.util.Date deadlineTime,
                                           int priority,
                                           java.lang.String description,
                                           java.lang.String group,
                                           java.lang.String owner,
                                           java.lang.String ownerDescription,
                                           java.lang.String variableTable,
                                           java.lang.String authorityGroup,
                                           boolean holdAll,
                                           DependenciesResolutionOption dependeciesResolution,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           ConnEngineNotMasterException,
                                           java.rmi.RemoteException
Add the job stream instance.

Parameters:
context - The specified context
Returns:
List the list of added JobStream
Throws:
ConnException - A generic error has occurred.
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnTransportException - An error has occurred in accessing the data.
ConnEngineNotMasterException - If the operation is not perfomed on a master
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

makeJobInPlanIntoJobStreamInstance

public JobInPlan makeJobInPlanIntoJobStreamInstance(Identifier jobId,
                                                    Identifier jobStreamId,
                                                    java.lang.String alias,
                                                    Context context)
                                             throws ConnException,
                                                    ConnLockingException,
                                                    ConnNotFoundException,
                                                    ConnSecurityException,
                                                    ConnTransportException,
                                                    ConnValidationException,
                                                    ConnEngineNotMasterException,
                                                    java.rmi.RemoteException
This method generates a JobInPlan object starting from a JobDefinition taken from the database. This operation is not supported in z/OS environment.

Parameters:
jobId - The Id of the Job to submit.
jobStreamId - The Identifier in the plan of an existing JobStreamInPlan into which the submission should be performed.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the generated JobInPlan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

makeJobInPlan

public JobInPlan makeJobInPlan(Identifier jobId,
                               Identifier workstationId,
                               java.lang.String alias,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               ConnEngineNotMasterException,
                               java.rmi.RemoteException
This method generates a JobInPlan object starting from a JobDefinition taken from the database. This operation is not supported in z/OS environment.

Parameters:
jobId - The database Job Identifier, of the definition to submit.
workstationId - The Identifier in the plan of an existing WorkstationInPlan.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the generated JobInPlan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

makeJobStreamInPlan

public JobStreamInPlan makeJobStreamInPlan(Identifier jobStreamId,
                                           java.util.Date inputArrivalTime,
                                           java.lang.String alias,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           ConnEngineNotMasterException,
                                           java.rmi.RemoteException
This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The Job Stream Identifier, of the job Stream to submit.
inputArrivalTime - The date used to resolve the job stream dependencies.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the generated JobStreamInPlan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

addJobInstanceIntoJobStreamInstance

public Identifier addJobInstanceIntoJobStreamInstance(Identifier jobId,
                                                      Identifier jobStreamId,
                                                      java.lang.String alias,
                                                      Context context)
                                               throws ConnException,
                                                      ConnLockingException,
                                                      ConnNotFoundException,
                                                      ConnSecurityException,
                                                      ConnTransportException,
                                                      ConnValidationException,
                                                      ConnEngineNotMasterException,
                                                      java.rmi.RemoteException
This operation is not supported in z/OS environment.

Parameters:
jobId - The Job Identifier, of the definition to submit.
jobStreamId - The Identifier in the plan of an existing JobStreamInPlan into which the submission should be performed.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the Identifier of the added Job.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred

addJobInstance

public Identifier addJobInstance(Identifier jobId,
                                 Identifier workstationId,
                                 java.lang.String alias,
                                 Context context)
                          throws ConnException,
                                 ConnLockingException,
                                 ConnNotFoundException,
                                 ConnSecurityException,
                                 ConnTransportException,
                                 ConnValidationException,
                                 ConnEngineNotMasterException,
                                 java.rmi.RemoteException
This method Adds a Job Instance.

Parameters:
jobId - The Job Identifier
workstationId - The Identifier of the Workstation.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the Identifier of the added Job.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

addJobStreamInstance

public java.util.List addJobStreamInstance(Identifier jobStreamId,
                                           java.util.Date inputArrivalTime,
                                           java.lang.String alias,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           ConnEngineNotMasterException,
                                           java.rmi.RemoteException
This method adds a Job Stream to the current Plan.

Parameters:
jobStreamId - The Identifier of the Job Stream to add.
inputArrivalTime - The date used to resolve the job stream dependencies.
alias - The alias that should be used during the submission.
context - The user context, or null if a default context is to be used.
Returns:
the list the Identifier of the Job Streams added to the Plan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - This engine is not a Master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setJobInstance

public void setJobInstance(JobInPlan job,
                           Context context)
                    throws ConnException,
                           ConnLockingException,
                           ConnNotFoundException,
                           ConnSecurityException,
                           ConnTransportException,
                           ConnValidationException,
                           java.rmi.RemoteException
Change properties of the specified job.

Parameters:
job - The JobInPlan to be changed.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.
See Also:
JobInPlan

releaseJobStreamInstance

public void releaseJobStreamInstance(Identifier jobStreamId,
                                     Context context)
                              throws ConnException,
                                     ConnLockingException,
                                     ConnNotFoundException,
                                     ConnSecurityException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     java.rmi.RemoteException
Release the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan to be released
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

holdJobStreamInstance

public void holdJobStreamInstance(Identifier jobStreamId,
                                  Context context)
                           throws ConnException,
                                  ConnLockingException,
                                  ConnNotFoundException,
                                  ConnSecurityException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  java.rmi.RemoteException
Holds the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan to hold
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

cancelJobStreamInstance

public void cancelJobStreamInstance(Identifier jobStreamId,
                                    boolean pending,
                                    Context context)
                             throws ConnException,
                                    ConnLockingException,
                                    ConnNotFoundException,
                                    ConnSecurityException,
                                    ConnTransportException,
                                    ConnValidationException,
                                    java.rmi.RemoteException
Cancel the specified job stream. The cancel-pending operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan to cancel
pending - True if this operation is a cancel-pending, false otherwise.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

releaseAllJobStreamInstanceDependencies

public void releaseAllJobStreamInstanceDependencies(Identifier jobStreamId,
                                                    Context context)
                                             throws ConnException,
                                                    ConnLockingException,
                                                    ConnNotFoundException,
                                                    ConnSecurityException,
                                                    ConnTransportException,
                                                    ConnValidationException,
                                                    java.rmi.RemoteException
Release all the dependencies from the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan from which all the dependencies should be released.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

releaseJobStreamInstanceDependencies

public void releaseJobStreamInstanceDependencies(Identifier jobStreamId,
                                                 java.util.List fileDeps,
                                                 java.util.List resourceDeps,
                                                 java.util.List promptDeps,
                                                 java.util.List externalDeps,
                                                 java.util.List internetworkDeps,
                                                 Context context)
                                          throws ConnException,
                                                 ConnLockingException,
                                                 ConnNotFoundException,
                                                 ConnSecurityException,
                                                 ConnTransportException,
                                                 ConnValidationException,
                                                 java.rmi.RemoteException
Release the specified dependencies from the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan from which the specified dependencies should be released.
fileDeps - A List of FileDependencyInPlan objects to be released.
resourceDeps - A List of ResourceDependencyInPlan objects to be released.
promptDeps - A List of PromptDependencyInPlan objects to be released.
externalDeps - A List of ExternalDependencyInPlan objects to be released.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be released.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

removeJobStreamInstanceDependencies

public void removeJobStreamInstanceDependencies(Identifier jobStreamId,
                                                java.util.List fileDeps,
                                                java.util.List resourceDeps,
                                                java.util.List promptDeps,
                                                java.util.List externalDeps,
                                                java.util.List internetworkDeps,
                                                Context context)
                                         throws ConnException,
                                                ConnLockingException,
                                                ConnNotFoundException,
                                                ConnSecurityException,
                                                ConnTransportException,
                                                ConnValidationException,
                                                java.rmi.RemoteException
Remove the specified dependencies from the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan from which the specified dependencies should be removed.
fileDeps - A List of FileDependencyInPlan objects to be removed.
resourceDeps - A List of ResourceDependencyInPlan objects to be removed.
promptDeps - A List of PromptDependencyInPlan objects to be removed.
externalDeps - A List of ExternalDependencyInPlan objects to be removed.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be removed.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

addJobStreamInstanceDependencies

public void addJobStreamInstanceDependencies(Identifier jobStreamId,
                                             java.util.List fileDeps,
                                             java.util.List resourceDeps,
                                             java.util.List promptDeps,
                                             java.util.List externalDeps,
                                             java.util.List internetworkDeps,
                                             Context context)
                                      throws ConnException,
                                             ConnLockingException,
                                             ConnNotFoundException,
                                             ConnSecurityException,
                                             ConnTransportException,
                                             ConnValidationException,
                                             java.rmi.RemoteException
Add the specified dependencies to the specified job stream. This operation is not supported in z/OS environment.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan from which the specified dependencies should be added.
fileDeps - A List of FileDependencyInPlan objects to be added.
resourceDeps - A List of ResourceDependencyInPlan objects to be added.
promptDeps - A List of PromptDependencyInPlan objects to be added.
externalDeps - A List of ExternalDependencyInPlan objects to be added.
internetworkDeps - A List of InternetworkDependencyInPlan objects to be added.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

monitorAllJobsInStreamInstance

public void monitorAllJobsInStreamInstance(Identifier jobStreamId,
                                           boolean monitor,
                                           Context context)
                                    throws ConnException,
                                           ConnLockingException,
                                           ConnNotFoundException,
                                           ConnSecurityException,
                                           ConnTransportException,
                                           ConnValidationException,
                                           java.rmi.RemoteException
Set/deset the monitor flag on all the job instance part of the specified job stream instance.

Parameters:
jobStreamId - The identifier of the JobStreamInPlan that owns the jobs to change.
monitor - true if all the jobs in the job stream should be monitored, false otherwise.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setJobStreamInstance

public Identifier setJobStreamInstance(JobStreamInPlan jobStream,
                                       Context context)
                                throws ConnException,
                                       ConnLockingException,
                                       ConnNotFoundException,
                                       ConnSecurityException,
                                       ConnTransportException,
                                       ConnValidationException,
                                       java.rmi.RemoteException
Change properties of the specified job stream.

Parameters:
jobStream - The JobStreamInPlan object to change.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.
See Also:
JobStreamInPlan

getEngineInformation

public EngineInformation getEngineInformation(Context context)
                                       throws ConnException,
                                              ConnLockingException,
                                              ConnNotFoundException,
                                              ConnSecurityException,
                                              ConnTransportException,
                                              ConnValidationException,
                                              java.rmi.RemoteException
Returns the engine information taken from the current Plan. This operation is not supported in z/OS environment.

Parameters:
context - The user context, or null if a default context is to be used.
Returns:
an utility object containing the engine information as they are present in the current Plan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

getJobInstanceOutput

public GetJobOutputResult getJobInstanceOutput(GetJobOutputContext context)
                                        throws ConnException,
                                               ConnLockingException,
                                               ConnNotFoundException,
                                               ConnSecurityException,
                                               ConnTransportException,
                                               ConnValidationException,
                                               java.rmi.RemoteException
Return output in bunch, after the first one, of a JobInPlan. To retrieve the first one the method getJobInstanceOutput(Identifier, int, Context) should be used.

Parameters:
context - The GetJobOutputContext part of the GetJobOutputResult returned by the previous call to the method.
Returns:
the GetJobOutputResult, containing a partial result, and a context that can be used for the next call. If the returned buffer is null the iteration is ended.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

getJobInstanceOutput

public GetJobOutputResult getJobInstanceOutput(Identifier jobId,
                                               int lines,
                                               Context context)
                                        throws ConnException,
                                               ConnLockingException,
                                               ConnNotFoundException,
                                               ConnSecurityException,
                                               ConnTransportException,
                                               ConnValidationException,
                                               java.rmi.RemoteException
Return the first bunch of a JobInPlan output.

Parameters:
jobId - The identifier of the JobInPlan from which take the output.
lines - The number of lines that should be returned in each call.
context - The user context, or null if a default context is to be used.
Returns:
the GetJobOutputResult.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

replyPrompt

public void replyPrompt(Identifier id,
                        boolean answer,
                        Context context)
                 throws ConnException,
                        ConnLockingException,
                        ConnNotFoundException,
                        ConnSecurityException,
                        ConnTransportException,
                        ConnValidationException,
                        java.rmi.RemoteException
Reply 'YES' (true) or 'NO' (false) to the sopecified prompt.

Parameters:
id - The identifier of the PromptInPlan to which you are answering.
answer - true if the answer is 'YES', false if it is 'NO'.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

setResourceInstance

public void setResourceInstance(ResourceInPlan resource,
                                Context context)
                         throws ConnException,
                                ConnLockingException,
                                ConnNotFoundException,
                                ConnSecurityException,
                                ConnTransportException,
                                ConnValidationException,
                                java.rmi.RemoteException
Change properties of the specified resource.

Parameters:
resource - The ResourceInPlan object to change.
context - The user context, or null if a default context is to be used.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

createPlan

public Identifier createPlan(SymphonyInPlanKey key,
                             java.util.Date startTime,
                             long timeExtension,
                             Context context)
                      throws ConnException,
                             ConnLockingException,
                             ConnNotFoundException,
                             ConnSecurityException,
                             ConnTransportException,
                             ConnValidationException,
                             ConnEngineNotMasterException,
                             java.rmi.RemoteException
This method is used to create a Trial or a Forecast plan. This operation is not supported in z/OS environment.

Parameters:
key - the key, containing the name, and the type of the Plan that will be generated.
startTime - The Date of the start of the Plan that will be generated.
timeExtension - The time duration of the generated plan
context - The user context, or null if a default context is to be used.
Returns:
the PlanIdentifier of the generated Plan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - if the engine is not a master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

createPlanExtension

public Identifier createPlanExtension(SymphonyInPlanKey key,
                                      long timeExtension,
                                      Context context)
                               throws ConnException,
                                      ConnLockingException,
                                      ConnNotFoundException,
                                      ConnSecurityException,
                                      ConnTransportException,
                                      ConnValidationException,
                                      ConnEngineNotMasterException,
                                      java.rmi.RemoteException
This method is used to create a Trial Plan extension starting from the current Plan. This operation is not supported in z/OS environment.

Parameters:
key - the key, containing the name, and the type of the Plan that will be generated.
timeExtension - The time duration of the generated plan
context - The user context, or null if a default context is to be used.
Returns:
the PlanIdentifier of the generated Plan.
Throws:
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnEngineNotMasterException - if the engine is not a master
ConnException - A generic error has occurred.
RemoteException - A Remote Exception occurred.

beginModifyPlanObject

public void beginModifyPlanObject(java.lang.Class cl,
                                  Identifier id,
                                  Context context)
                           throws ConnException,
                                  ConnIntegrityException,
                                  ConnNotFoundException,
                                  ConnLockingException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  ConnSecurityException,
                                  java.rmi.RemoteException
Start the modify session for the TWSObject object identified by the given id.

Parameters:
cl - class of the TWS objects to Commit the modifications.
id - The identifier of the object to Commit the modifications.
context - containing userSession The session of the user who starting the modify.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

commitModifyPlanObject

public void commitModifyPlanObject(java.lang.Class cl,
                                   Identifier id,
                                   Context context)
                            throws ConnException,
                                   ConnIntegrityException,
                                   ConnNotFoundException,
                                   ConnLockingException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   ConnSecurityException,
                                   java.rmi.RemoteException
Commit the modification to the TWSObject object identified by the given id.

Parameters:
cl - class of the TWS objects to Commit the modifications.
id - The identifier of the object to Commit the modifications.
context - containing userSession The session of the user who starting the modify.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

rollbackModifyPlanObject

public void rollbackModifyPlanObject(java.lang.Class cl,
                                     Identifier id,
                                     Context context)
                              throws ConnException,
                                     ConnIntegrityException,
                                     ConnNotFoundException,
                                     ConnLockingException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     ConnSecurityException,
                                     java.rmi.RemoteException
rollback the modification to the TWSObject object identified by the given id.

Parameters:
cl - class of the TWS objects to rollback the modifications.
id - The identifier of the object to rollback the modifications.
context - containing userSession The session of the user who starting the modify.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

commitJobRestartAndCleanup

public void commitJobRestartAndCleanup(java.lang.Class cl,
                                       Identifier id,
                                       Context context)
                                throws ConnException,
                                       ConnIntegrityException,
                                       ConnNotFoundException,
                                       ConnLockingException,
                                       ConnTransportException,
                                       ConnValidationException,
                                       ConnSecurityException,
                                       java.rmi.RemoteException
Commit the restartAndCleanup modification done on the TWSObject object identified by the given id.

Parameters:
cl - class of the TWS objects to commit the modifications.
context - containing userSession The session of the user who started the restart and cleanup operations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

rollbackJobRestartAndCleanup

public void rollbackJobRestartAndCleanup(java.lang.Class cl,
                                         Identifier id,
                                         Context context)
                                  throws ConnException,
                                         ConnIntegrityException,
                                         ConnNotFoundException,
                                         ConnLockingException,
                                         ConnTransportException,
                                         ConnValidationException,
                                         ConnSecurityException,
                                         java.rmi.RemoteException
Rollback the restartAndCleanup modification done on the TWSObject object identified by the given id.

Parameters:
cl - class of the TWS objects to rollback the modifications.
context - containing userSession The session of the user who started the restart and cleanup operations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

setWorkstationInstance

public void setWorkstationInstance(WorkstationInPlan workstation,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
Set the values for the input Workstation instance.

Parameters:
workstation - The Workstaion Instance to be changed.
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setWorkstationStatus

public void setWorkstationStatus(Identifier id,
                                 Context context,
                                 WorkstationStatus status,
                                 WorkstationOperationOption options,
                                 WorkstationInPlanKey alternateWorkstation)
                          throws ConnException,
                                 ConnLockingException,
                                 ConnNotFoundException,
                                 ConnSecurityException,
                                 ConnTransportException,
                                 ConnValidationException,
                                 java.rmi.RemoteException
Set the status for the input Workstation instance.

Parameters:
id - The Workstation Instance to be changed.
context - The specified context
status - The Status
options - The action to perform on started operations
alternateWorkstation - The alternate workstation for reroute, null if jobs will not need to be rerouted.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

nopJobInstance

public void nopJobInstance(Identifier jobId,
                           Context context)
                    throws ConnException,
                           ConnLockingException,
                           ConnNotFoundException,
                           ConnSecurityException,
                           ConnTransportException,
                           ConnValidationException,
                           java.rmi.RemoteException
NOP the job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

unNopJobInstance

public void unNopJobInstance(Identifier jobId,
                             Context context)
                      throws ConnException,
                             ConnLockingException,
                             ConnNotFoundException,
                             ConnSecurityException,
                             ConnTransportException,
                             ConnValidationException,
                             java.rmi.RemoteException
Un NOP the job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

executeJobInstance

public void executeJobInstance(Identifier jobId,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Execute the job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

executeJobAutomaticRecovery

public void executeJobAutomaticRecovery(Identifier jobId,
                                        Context context)
                                 throws ConnException,
                                        ConnLockingException,
                                        ConnNotFoundException,
                                        ConnSecurityException,
                                        ConnTransportException,
                                        ConnValidationException,
                                        java.rmi.RemoteException
Execute the automatic recovery for the job specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

modifyJobInstanceDependencies

public void modifyJobInstanceDependencies(Identifier jobId,
                                          java.util.List removeResourceDeps,
                                          java.util.List removeInternalDeps,
                                          java.util.List removeExternalDeps,
                                          java.util.List removeInternalSucc,
                                          java.util.List removeExternalSucc,
                                          java.util.List addResourceDeps,
                                          java.util.List addInternalDeps,
                                          java.util.List addExternalDeps,
                                          java.util.List addInternalSucc,
                                          java.util.List addExternalSucc,
                                          Context context)
                                   throws ConnException,
                                          ConnLockingException,
                                          ConnNotFoundException,
                                          ConnSecurityException,
                                          ConnTransportException,
                                          ConnValidationException,
                                          java.rmi.RemoteException
Modify the specified dependences of a job instance specified by the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
addExternalSucc - The External Successors List to add
addInternalSucc - The Internal Successors List to add
addExternalDeps - The External Dependencies List to add
addInternalDeps - The Internal Dependencies List to add
addResourceDeps - The Resource Dependencies List to add
removeExternalSucc - The External Successors List to remove
removeInternalSucc - The Internal Successors List to remove
removeExternalDeps - The External Dependencies List to remove
removeInternalDeps - The Internal Dependencies List to remove
removeResourceDeps - The Resource Dependencies List to remove
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setToWaitJobStreamInstance

public void setToWaitJobStreamInstance(Identifier id,
                                       Context context)
                                throws ConnException,
                                       ConnLockingException,
                                       ConnNotFoundException,
                                       ConnSecurityException,
                                       ConnTransportException,
                                       ConnValidationException,
                                       java.rmi.RemoteException
Set the job stream instance to wait.

Parameters:
id - The Job Stream Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

completeJobStreamInstance

public void completeJobStreamInstance(Identifier id,
                                      Context context)
                               throws ConnException,
                                      ConnLockingException,
                                      ConnNotFoundException,
                                      ConnSecurityException,
                                      ConnTransportException,
                                      ConnValidationException,
                                      java.rmi.RemoteException
Complete the job stream instance to wait.

Parameters:
id - The Job Stream Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

holdJobStreamInstanceJobs

public void holdJobStreamInstanceJobs(Identifier id,
                                      boolean holdAll,
                                      Context context)
                               throws ConnException,
                                      ConnLockingException,
                                      ConnNotFoundException,
                                      ConnSecurityException,
                                      ConnTransportException,
                                      ConnValidationException,
                                      java.rmi.RemoteException
Hold all the job stream jobs.

Parameters:
id - The Job Stream Instance identifier
holdAll - the job stream hold all option.
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setJobInstanceStatus

public void setJobInstanceStatus(Identifier jobId,
                                 FlowNodeInternalStatusType status,
                                 java.lang.String errorCode,
                                 Context context)
                          throws ConnException,
                                 ConnLockingException,
                                 ConnNotFoundException,
                                 ConnSecurityException,
                                 ConnTransportException,
                                 ConnValidationException,
                                 java.rmi.RemoteException
Set the status of the job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
status - The status of the job instance.
errorCode - The errocode to be set
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobJCL

public JobControlLanguage getJobJCL(Identifier jobId,
                                    boolean isForRestartAndCleanup,
                                    Context context)
                             throws ConnException,
                                    ConnLockingException,
                                    ConnNotFoundException,
                                    ConnSecurityException,
                                    ConnTransportException,
                                    ConnValidationException,
                                    java.rmi.RemoteException
Return the requested job JCL

Parameters:
jobId - The Job Instance identifier
isForRestartAndCleanup - Must be set to true if the JCL to be get is the restart an cleanup JCL
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setJobJCL

public void setJobJCL(Identifier jobId,
                      JobControlLanguage jcl,
                      boolean isForRestartCleanup,
                      Context context)
               throws ConnException,
                      ConnLockingException,
                      ConnNotFoundException,
                      ConnSecurityException,
                      ConnTransportException,
                      ConnValidationException,
                      java.rmi.RemoteException
Set the requested job JCL

Parameters:
jobId - The Job Instance identifier
jcl - The job JCL
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobJCLPromptableVariableList

public java.util.List getJobJCLPromptableVariableList(Identifier jobId,
                                                      Context context)
                                               throws ConnException,
                                                      ConnLockingException,
                                                      ConnNotFoundException,
                                                      ConnSecurityException,
                                                      ConnTransportException,
                                                      ConnValidationException,
                                                      java.rmi.RemoteException
Return the requested job JCL promptable variable list.

Parameters:
jobId - The Job Instance identifier.
context - The specified context.
Returns:
The requested informations.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setJobJCLPromptableVariableList

public void setJobJCLPromptableVariableList(Identifier jobId,
                                            java.util.List variables,
                                            Context context)
                                     throws ConnException,
                                            ConnLockingException,
                                            ConnNotFoundException,
                                            ConnSecurityException,
                                            ConnTransportException,
                                            ConnValidationException,
                                            java.rmi.RemoteException
Set the requested job JCL promptable variable list.

Parameters:
jobId - The Job Instance identifier
variables - The list of promptable variables.
context - The specified context.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

solveJobJCLNoPromptableVariableList

public JobControlLanguage solveJobJCLNoPromptableVariableList(Identifier jobId,
                                                              Context context)
                                                       throws ConnException,
                                                              ConnLockingException,
                                                              ConnNotFoundException,
                                                              ConnSecurityException,
                                                              ConnTransportException,
                                                              ConnValidationException,
                                                              java.rmi.RemoteException
Return the requested job JCL variable list.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Returns:
The requested JobControlLanguage
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

beginJobRestartCleanup

public void beginJobRestartCleanup(Identifier jobId,
                                   RestartCleanupOptions options,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
Execute Restart and Cleanup for the requested job instance.

Parameters:
jobId - The Job Instance identifier
options - The Restart and Cleanup options
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

executeJobRestartCleanup

public void executeJobRestartCleanup(Identifier jobId,
                                     java.lang.String errorCode,
                                     java.lang.String userData,
                                     java.lang.String reason,
                                     Context context)
                              throws ConnException,
                                     ConnLockingException,
                                     ConnNotFoundException,
                                     ConnSecurityException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     java.rmi.RemoteException
Execute Restart and Cleanup for the requested job instance.

Parameters:
jobId - The Job Instance identifier
context - The specified context
reason - A String containing the Reason
userData - A String containing the User Data
errorCode - A String containing the Error Code
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobCleanupResult

public java.util.List getJobCleanupResult(Identifier jobId,
                                          Context context)
                                   throws ConnException,
                                          ConnLockingException,
                                          ConnNotFoundException,
                                          ConnSecurityException,
                                          ConnTransportException,
                                          ConnValidationException,
                                          java.rmi.RemoteException
Returns Cleanup result for the requested job instance.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobDataSetsWithAutomaticRecovery

public DataSetsListResult getJobDataSetsWithAutomaticRecovery(Identifier jobId,
                                                              Context context)
                                                       throws ConnException,
                                                              ConnLockingException,
                                                              ConnNotFoundException,
                                                              ConnSecurityException,
                                                              ConnTransportException,
                                                              ConnValidationException,
                                                              java.rmi.RemoteException
Returns the data set list for the requested job instance and the suggested restart step.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobDataSets

public java.util.List getJobDataSets(Identifier jobId,
                                     Context context)
                              throws ConnException,
                                     ConnLockingException,
                                     ConnNotFoundException,
                                     ConnSecurityException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     java.rmi.RemoteException
Returns the data set list for the requested job instance.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setJobDataSets

public void setJobDataSets(Identifier jobId,
                           java.util.List dataSets,
                           Context context)
                    throws ConnException,
                           ConnLockingException,
                           ConnNotFoundException,
                           ConnSecurityException,
                           ConnTransportException,
                           ConnValidationException,
                           java.rmi.RemoteException
Sets the data set list for the requested job instance.

Parameters:
jobId - The Job Instance identifier
dataSets - The data set list
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobRestartSteps

public java.util.List getJobRestartSteps(Identifier jobId,
                                         java.util.List stepList,
                                         boolean[] stepListCheck,
                                         Context context)
                                  throws ConnException,
                                         ConnLockingException,
                                         ConnNotFoundException,
                                         ConnSecurityException,
                                         ConnTransportException,
                                         ConnValidationException,
                                         java.rmi.RemoteException
Returns the restart step list and if is checked for the requested job instance.

Parameters:
jobId - The Job Instance identifier
stepList - The returned restart step list
stepListCheck - An array of one boolean where the method will return the information if the steplist is checked or not.
context - The specified context
Returns:
A List of JobStep objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setJobRestartSteps

public void setJobRestartSteps(Identifier jobId,
                               java.util.List stepList,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Sets the restart step list for the requested job instance.

Parameters:
jobId - The Job Instance identifier
stepList - The restart step list
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstanceRecoveryOutput

public GetJobOutputResult getJobInstanceRecoveryOutput(GetJobOutputContext context)
                                                throws ConnException,
                                                       ConnLockingException,
                                                       ConnNotFoundException,
                                                       ConnSecurityException,
                                                       ConnTransportException,
                                                       ConnValidationException,
                                                       java.rmi.RemoteException
Return the requested recovery job output informations

Parameters:
context - The context containing the required informations
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred.
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.
ConnLockingException

getJobInstanceRecoveryOutput

public GetJobOutputResult getJobInstanceRecoveryOutput(Identifier jobId,
                                                       int numOfLinesToRead,
                                                       Context context)
                                                throws ConnException,
                                                       ConnLockingException,
                                                       ConnNotFoundException,
                                                       ConnSecurityException,
                                                       ConnTransportException,
                                                       ConnValidationException,
                                                       java.rmi.RemoteException
Return the requested recovery job output informations

Parameters:
jobId - The Job Instance identifier
numOfLinesToRead - The number of joblog lines to be returned by this call.
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.
ConnLockingException

connectToHostCpu

public byte[] connectToHostCpu(Identifier workstationId,
                               java.lang.String connectionString,
                               byte[] command,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Return the byte array result of the invocation of the access method associated to the input Workstation.

Parameters:
workstationId - The Workstation identifier
connectionString - The string containing the parameters for TCPIP connection.
command - The command to send to the access method.
context - The specified context
Returns:
The requested informations
Throws:
ConnException - A generic error has occurred.
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

addJobInstanceSuccessors

public void addJobInstanceSuccessors(Identifier jobId,
                                     java.util.List internalDeps,
                                     java.util.List externalDeps,
                                     Context context)
                              throws ConnException,
                                     ConnLockingException,
                                     ConnNotFoundException,
                                     ConnSecurityException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     java.rmi.RemoteException
Add the specified successor dependencies to the specified job.

Parameters:
jobId - The identifier of the job.
internalDeps - The internal successors
externalDeps - The external successors
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

removeJobInstanceSuccessors

public void removeJobInstanceSuccessors(Identifier jobId,
                                        java.util.List internalDeps,
                                        java.util.List externalDeps,
                                        Context context)
                                 throws ConnException,
                                        ConnLockingException,
                                        ConnNotFoundException,
                                        ConnSecurityException,
                                        ConnTransportException,
                                        ConnValidationException,
                                        java.rmi.RemoteException
Remove the specified successors from the job identified by jobId

Parameters:
jobId - The identifier of the job.
internalDeps - The internal dependencies
externalDeps - The external dependencies
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstanceSuccessors

public java.util.List getJobInstanceSuccessors(Identifier jobId,
                                               Context context)
                                        throws ConnException,
                                               ConnNotFoundException,
                                               ConnSecurityException,
                                               ConnTransportException,
                                               ConnValidationException,
                                               java.rmi.RemoteException
Get the internal and external successors of a job.

Parameters:
jobId - The identifier of the job.
context - The specified context
Returns:
List A list of JobInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstancePredecessors

public java.util.List getJobInstancePredecessors(Identifier jobId,
                                                 Context context)
                                          throws ConnException,
                                                 ConnNotFoundException,
                                                 ConnSecurityException,
                                                 ConnTransportException,
                                                 ConnValidationException,
                                                 java.rmi.RemoteException
Get the internal and external predecessors of a job.

Parameters:
jobId - The identifier of the job.
context - The specified context
Returns:
List A list of JobInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstanceNonCompletedPredecessors

public java.util.List getJobInstanceNonCompletedPredecessors(Identifier jobId,
                                                             Context context)
                                                      throws ConnException,
                                                             ConnNotFoundException,
                                                             ConnSecurityException,
                                                             ConnTransportException,
                                                             ConnValidationException,
                                                             java.rmi.RemoteException
Get the non completed internal and external predecessors of a job.

Parameters:
jobId - The identifier of the job.
context - The specified context
Returns:
List A list of JobInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstanceNonWaitingSuccessors

public java.util.List getJobInstanceNonWaitingSuccessors(Identifier jobId,
                                                         Context context)
                                                  throws ConnException,
                                                         ConnNotFoundException,
                                                         ConnSecurityException,
                                                         ConnTransportException,
                                                         ConnValidationException,
                                                         java.rmi.RemoteException
Get the non waiting internal and external successors of a job.

Parameters:
jobId - The identifier of the job.
context - The specified context
Returns:
List A list of JobInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

setWholeJobInstance

public void setWholeJobInstance(JobInPlan job,
                                boolean changeStatus,
                                java.util.List removeResourceDeps,
                                java.util.List removeInternalDeps,
                                java.util.List removeExternalDeps,
                                java.util.List removeInternalSucc,
                                java.util.List removeExternalSucc,
                                java.util.List addResourceDeps,
                                java.util.List addInternalDeps,
                                java.util.List addExternalDeps,
                                java.util.List addInternalSucc,
                                java.util.List addExternalSucc,
                                Context context)
                         throws ConnException,
                                ConnLockingException,
                                ConnNotFoundException,
                                ConnSecurityException,
                                ConnTransportException,
                                ConnValidationException,
                                java.rmi.RemoteException
Change properties and dependencies of the specified job in a single atomic action

Parameters:
job - The job to be changed.
changeStatus - true means that job has changed is status
context - The specified context
addExternalSucc - The External Successors List to add
addInternalSucc - The Internal Successors List to add
addExternalDeps - The External Dependencies List to add
addInternalDeps - The Internal Dependencies List to add
addResourceDeps - The Resource Dependencies List to add
removeExternalSucc - The External Successors List to remove
removeInternalSucc - The Internal Successors List to remove
removeExternalDeps - The External Dependencies List to remove
removeInternalDeps - The Internal Dependencies List to remove
removeResourceDeps - the Resource Dependencies List to remove
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

queryJobInstanceResourceUsage

public QueryResult queryJobInstanceResourceUsage(QueryFilter filter,
                                                 int howMany,
                                                 Context context)
                                          throws ConnException,
                                                 ConnLockingException,
                                                 ConnNotFoundException,
                                                 ConnSecurityException,
                                                 ConnTransportException,
                                                 ConnValidationException,
                                                 java.rmi.RemoteException
Returns the list of Job In plan objects that are holding or waiting on the resource specified in the filter

Parameters:
filter - The filter used to search the headers to be queried.
howMany - how many objects to be returned in this call.
context - The specified context
Returns:
List A list of ResourceInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

queryNextJobInstanceResourceUsage

public QueryResult queryNextJobInstanceResourceUsage(QueryPlanContext queryContext)
                                              throws ConnException,
                                                     ConnLockingException,
                                                     ConnNotFoundException,
                                                     ConnSecurityException,
                                                     ConnTransportException,
                                                     ConnValidationException,
                                                     java.rmi.RemoteException
Return a list of JobInPlan Objects holding or waiting ona given resource according with the query context passed in input This list is contained in the QueryResult object

Parameters:
queryContext - This parameter contains the information retrieved from the preovious QueryNext or QueryTWSObject.
Returns:
QueryPlanResult The result of the query
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

getJobInstanceOperatorInstructions

public OperatorInstructionInPlan getJobInstanceOperatorInstructions(Identifier jobId,
                                                                    Context context)
                                                             throws ConnException,
                                                                    ConnNotFoundException,
                                                                    ConnSecurityException,
                                                                    ConnTransportException,
                                                                    ConnValidationException,
                                                                    java.rmi.RemoteException
Get the operator instructions associated to the specifid job in plan

Parameters:
jobId - The Job Instance identifier.
context - The specified context
Returns:
A OperatorInstructionInPlan object
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

beginJobRestartCleanupWithAR

public void beginJobRestartCleanupWithAR(Identifier jobId,
                                         RestartCleanupOptions options,
                                         Context context)
                                  throws ConnException,
                                         ConnLockingException,
                                         ConnNotFoundException,
                                         ConnSecurityException,
                                         ConnTransportException,
                                         ConnValidationException,
                                         java.rmi.RemoteException
Starts the Restart and Cleanup (with AR) for the requested job instance.

Parameters:
jobId - The Job Instance identifier
options - The Restart and Cleanup options
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

beginJobJCL

public void beginJobJCL(Identifier id,
                        Context context)
                 throws ConnException,
                        ConnIntegrityException,
                        ConnNotFoundException,
                        ConnLockingException,
                        ConnTransportException,
                        ConnValidationException,
                        ConnSecurityException,
                        java.rmi.RemoteException
Start the modify session for the JCL of the job identified by the given id.

Parameters:
id - The identifier of the job to begin the modifications.
context - containing userSession The session of the user who starting the modify.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

commitJobJCL

public void commitJobJCL(Identifier jobId,
                         Context context)
                  throws ConnException,
                         ConnIntegrityException,
                         ConnNotFoundException,
                         ConnLockingException,
                         ConnTransportException,
                         ConnValidationException,
                         ConnSecurityException,
                         java.rmi.RemoteException
Commit the JCL modification done on the job identified by the given id.

Parameters:
jobId - The identifier of the job to commit the modifications.
context - containing userSession The session of the user who started the JCL operations.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

rollbackJobJCL

public void rollbackJobJCL(Identifier jobId,
                           boolean forJCLPREP,
                           Context context)
                    throws ConnException,
                           ConnIntegrityException,
                           ConnNotFoundException,
                           ConnLockingException,
                           ConnTransportException,
                           ConnValidationException,
                           ConnSecurityException,
                           java.rmi.RemoteException
Rollback the JCL modification done on the job identified by the given id.

Parameters:
jobId - The identifier of the job to rollback the modifications.
forJCLPREP - flag specifying JCLPREP.
context - containing userSession The session of the user who started the JCL operations.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
RemoteException - A Remote Exception occurred.

countPlanObject

public java.util.List countPlanObject(java.lang.Class cl,
                                      QueryFilter filter,
                                      java.lang.String groupField,
                                      Context context)
                               throws ConnException,
                                      ConnLockingException,
                                      ConnNotFoundException,
                                      ConnSecurityException,
                                      ConnTransportException,
                                      ConnValidationException,
                                      java.rmi.RemoteException
This method returns aggregate statistics on plan objects. The list of objects is returned according to the filter and grouped by the group field parameter. If the requested group field is NO_GROUP the returned list will contain the count of all objects.

Parameters:
cl - The Class of the headers to be retrieved.
filter - the QueryFilter object that contains the filters to be used during the query. Only filters specific of the object requested are considered.
groupField - the field on which group the objects in each call.
context - The user context, or null if a default context is to be used.
Returns:
A List of ObjectCount objects, each one containing a value of the group field and the number of objects that have that value for that field.
Throws:
ConnException - A generic error has occurred.
ConnLockingException - An error has occured related to locking of data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
java.rmi.RemoteException - A Remote Exception occurred.

getCriticalPath

public java.util.List getCriticalPath(Identifier jobId,
                                      Context context)
                               throws ConnException,
                                      ConnNotFoundException,
                                      ConnSecurityException,
                                      ConnTransportException,
                                      ConnValidationException,
                                      java.rmi.RemoteException
Get the critical path jobs list.

Parameters:
jobId - The identifier of the job.
context - The specified context
Returns:
List A list of JobInPlan Objects
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

killFTAJobInstance

public void killFTAJobInstance(Identifier jobId,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnNotFoundException,
                               ConnSecurityException,
                               ConnTransportException,
                               ConnValidationException,
                               java.rmi.RemoteException
Kill the FTA job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.

killRecoveryJobInstance

public void killRecoveryJobInstance(Identifier jobId,
                                    Context context)
                             throws ConnException,
                                    ConnLockingException,
                                    ConnNotFoundException,
                                    ConnSecurityException,
                                    ConnTransportException,
                                    ConnValidationException,
                                    java.rmi.RemoteException
Kill the recovery job instance specified in the jobId.

Parameters:
jobId - The Job Instance identifier
context - The specified context
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - It has been impossible to lock the object.
ConnNotFoundException - The object was not found.
ConnSecurityException - A security error has occurred accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
RemoteException - A Remote Exception occurred.


Copyright © 2005 IBM All Rights Reserved.