com.ibm.tws.conn.plan
Interface ConnPlan


public interface ConnPlan

Remote interface for Enterprise Bean: ConnPlan. This interface contains all the valid methods that can be invoked remotely on the Distributed Plan Connector.


Method Summary
 Identifier addJobInstance(Identifier jobDefinitionId, Identifier workstationId, java.lang.String alias, Context context)
          This method performs the operations of makeJobInPlan and addJobInstance in a single invokation, without allowing user manipulation of the object.
 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 jobDefinitionId, Identifier jobStreamId, java.lang.String alias, Context context)
          This method performs the operations of makeJobInPlanIntoJobStreamInstance and addJobInstance in a single invokation, without allowing user manipulation of the object.
 java.util.List addJobStreamInstance(Identifier jobStreamId, java.util.Date inputArrivalTime, java.lang.String alias, Context context)
          This method performs the operations of makeJobStreamInPlan and addJobStreamInstance in a single invokation, without allowing user manipulation of the object.
 java.util.List addJobStreamInstance(JobStreamInPlan jobStream, Context context)
          Add the input job stream instance to the current Plan.
 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 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 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)
          This method connects a remote workstation via TCP/IP (with options), sends a command to it, and receives the result from it.
 java.util.List countPlanObject(java.lang.Class cl, QueryFilter filter, java.lang.String groupField, Context context)
          This method return 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, depending on the type specified in the SymphonyInPlanKey, with the name specified in the key itself.
 Identifier createPlanExtension(SymphonyInPlanKey key, long timeExtension, Context context)
          This method is used to create a Trial Plan extension starting from the current Plan.
 EngineInformation getEngineInformation(Context context)
          Returns the engine information taken from the current 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.
 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 killJobInstance(Identifier jobId, Context context)
          Kill the specified job.
 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 jobDefinitionId, 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 jobDefinitionId, 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 method generates a JobStreamInPlan object starting from a JobStream taken from the database.
 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.
 QueryResult queryNext(QueryPlanContext queryContext)
          Return a list of objects according with the Filter present in the context.
 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 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 setJobInstance(JobInPlan job, Context context)
          Change properties of the specified job.
 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 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 setWorkstationLimit(Identifier id, int limit, Context context)
          Sets the Workstation Instance new Limit.
 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.
 

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. Note that the start is not supported for XA. 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. Note that the stop is not supported for XA. 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. Note that the link is not supported for XA.

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. Note that the unlink is not supported for XA.

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. Valid values are between -1 and 1024. 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. Valid values are between 0 and 101. 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. If the password is set to null, the user specified by the given Identifier is loaded, the old password is retrieved, and it is tored again encrypted with the new user name specified in the WindowsUserInPlanKey. If a password is passed to the API it should be always be not encrypted, that is WindowsUserInPlan.isEncrypted must be false. The connector code will take care of encrypt it before save it to file. 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. Valid values are:
  • DomainInPlan
  • FileInPlan
  • JobInPlan
  • JobStreamInPlan
  • PromptInPlan
  • ResourceInPlan
  • SymphonyInPlan
  • WindowsUserInPlan
  • WorkstationInPlan
  • 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. If the requested class is JobInPlan or JobStreamInPlan their dependencies are not filled by this method, but are returned as an empty List. 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. Valid values are:
  • DomainInPlan
  • FileInPlan
  • JobInPlan
  • JobStreamInPlan
  • PromptInPlan
  • ResourceInPlan
  • SymphonyInPlan
  • WindowsUserInPlan
  • WorkstationInPlan
  • filter - the QueryFilter object that contains the filters to be used during the query. Only filters specific of the object requested are considered.
    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.
    See Also:
    DomainInPlanFilters, FileInPlanFilters, JobInPlanFilters, JobStreamInPlanFilters, PromptInPlanFilters, ResourceInPlanFilters, SymphonyInPlanFilters, WindowsUserInPlanFilters, WorkstationInPlanFilters, QueryFilter

    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. For the first calls use the method queryPlanObject. To simplify the iteration on the returned bunches it is recommended to use the ConnPlanIterator.

    Parameters:
    queryContext - The context present in the QueryResult returned in the previous call.
    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.

    releaseJobInstance

    public void releaseJobInstance(Identifier jobId,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
    Release the specified job. For the operation to succeed to Job should not be JobInPlan.canceled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. For the operation to succeed to Job should not be JobInPlan.canceled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. If the job is not JobInPlan.external and not JobInPlan.canceled, this operation will succeed if the job is in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_EXEC
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_MPE_INTRO
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_ABEND_P
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_SUCC_P
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_END_P
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_UNKNOWN
  • 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. Valid values are:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_SUCC
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_ABEND
  • 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. The kill operation cannot be performed if the job is in one of the following status:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_END_P
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANT_STREAM
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_SUCC
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_ABEND
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_UNKNOWN
  • 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 method can perform the different operations, depending on the values specified in the RerunDetails object:
  • simple rerun, if neither the stepName not the jobDefinitionDbIdentifier are specified
  • rerun step, if stepName is specified
  • rerun from, if jobDefinitionDbIdentifier is specified
  • If the operation performed is (or contains as part) the 'rerun from' the operation can be performed only if the engine is a master. This operation can be perfomed only on jobs (not JobInPlan.external and not JobInPlan.canceled) in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANT_STREAM
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_SUCC
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_ABEND
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_UNKNOWN
  • Finally this operation cannot be performed on jobs with JobInPlan.successPending set to true. 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.
    See Also:
    RerunDetails

    cancelJobInstance

    public void cancelJobInstance(Identifier jobId,
                                  boolean pending,
                                  Context context)
                           throws ConnException,
                                  ConnLockingException,
                                  ConnNotFoundException,
                                  ConnSecurityException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  java.rmi.RemoteException
    Cancel the specified job. If a pending value equals to true is specified, instead of a normal cancel operation, a cancel pending operation is performed. The operation cannot be performed if the job is JobInPlan.canceled or is in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. The dependencies specified are dependencies present on the job itself. 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.
    See Also:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, InternalDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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. The dependencies specified are dependencies present on the job itself.

    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.
    See Also:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, InternalDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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. The dependencies specified are dependencies not present on the job itself.

    Parameters:
    jobId - The identifier of the JobInPlan from which the specified dependencies should be added.
    fileDeps - A List of FileDependencyInPlan objects to be added. The referenced FileInPlan objects could be still not present in the Plan.
    resourceDeps - A List of ResourceDependencyInPlan objects to be added. The referenced ResorceInPlan objects should be already present in the Plan.
    promptDeps - A List of PromptDependencyInPlan objects to be added. If the referenced PromptInPlan is predefined, it should be already present in the Plan; if it is an ad-hoc prompt it could be not.
    internalDeps - A List of InternalDependencyInPlan objects to be added. The referenced JobInPlan objects should be already present in the Plan.
    externalDeps - A List of ExternalDependencyInPlan objects to be added. The referenced objects (either JobInPlan or JobStreamInPlan) should be already present in the Plan.
    internetworkDeps - A List of InternetworkDependencyInPlan objects to be added. The referenced WorkstationInPlan objects should be already present in the Plan.
    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:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, InternalDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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 method can perform two different kind of operation:
  • submission
  • ad-hoc submission
  • In the first case the object created by either the makeJobInPlan or makeJobInPlanIntoJobStreamInstance method, and eventually manipulated, should be passed to this method for submission. In the second case a newly created object should be passed to this method. Note that ad-hoc submission is supported also on FTA and not only on Master. This requies that in the object passsed to this method no prompt and no resource taken from database and not present in the plan should be specified. Obviosly if the engine is a master this limitation is not present, and the ad-hoc submission can be permormed also with prompts and resources taken from ther database. If this method should search the database for an object that is not present in the Plan and it cannot do it because the engine is not a master, a ConnNotFoundException is thrown. For details on how to manipulate the input object, see the JobInPlan documentation. 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
    See Also:
    JobInPlan

    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 method can be invoked only on master engine. This method performs the Job Stream submission of the Job Stream returned by the method makeJobStreamInPlan. If the Job Stream in the Database is defined on a Workstation Class, the makeJobStreamInPlan methods returns a 'sample' Job Stream. In this case, this method performs a multiple submission, one Job Stream for each Workstation present in the Workstation Class. If some error occurs, it continues the operation, and at the end throws an exception containing the error occurred. For details on how to manipulate the input object, see the JobStreamInPlan documentation. 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

    makeJobInPlanIntoJobStreamInstance

    public JobInPlan makeJobInPlanIntoJobStreamInstance(Identifier jobDefinitionId,
                                                        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. The generated object will be part of the JobStreamInPlan referenced by the input identifer and will have the input alias set. The generated object is ready for manipulation (made by the user) and then sumbission (made through the method addJobInstance(JobInPlan, Context)). This method can be invoked only on the master engine. For details on how to manipulate the output object, see the JobInPlan documentation. This operation is not supported in z/OS environment.

    Parameters:
    jobDefinitionId - The database JobDefinition 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 generated JobInPlan, ready to be manipulated and submitted.
    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:
    JobInPlan

    makeJobInPlan

    public JobInPlan makeJobInPlan(Identifier jobDefinitionId,
                                   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. The generated object will be part of the job stream JOBS in the WorkstationInPlan referenced by the input identifer and will have the input alias set. The generated object is ready for manipulation (made by the user) and then sumbission (made through the method addJobInstance(JobInPlan, Context)). Note that if the job stream is not yet present it will be created during the invocation of the method addJobInstance(JobInPlan, Context). Note that if the generation of the Job should be performed not in the actually valid JOBS job stream but in a previous one, the method makeJobInPlanIntoJobStreamInstance should be used, using the Identifier of the already existent JOBS job stream. This method can be invoked only on the master engine. For details on how to manipulate the output object, see the JobInPlan documentation. This operation is not supported in z/OS environment.

    Parameters:
    jobDefinitionId - The database JobDefinition 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, ready to be manipulated and submitted.
    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:
    JobInPlan

    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 method generates a JobStreamInPlan object starting from a JobStream taken from the database. The generated object will contain its dependencies resolved using its matching criteria and the inputArrivalTime passed, its job with their dependencies and will have the input alias set. The generated object is ready for manipulation (made by the user) and then sumbission (made through the method addJobStreamInstance(JobStreamInPlan, Context)). If the databasa object is defined on a WorkstationClass it could happen that more than one plan object correspond to it. In this case, just one sample object is returned. The method addJobStreamInstance(JobStreamInPlan, Context) will take care of the submission of the different instances. This method can be invoked only on the master engine. For details on how to manipulate the output object, see the JobStreamInPlan documentation. This operation is not supported in z/OS environment.

    Parameters:
    jobStreamId - The database JobStream 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, ready to be manipulated and submitted, or a sample job stream if the database object is defined on a WorkstationClass
    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

    addJobInstanceIntoJobStreamInstance

    public Identifier addJobInstanceIntoJobStreamInstance(Identifier jobDefinitionId,
                                                          Identifier jobStreamId,
                                                          java.lang.String alias,
                                                          Context context)
                                                   throws ConnException,
                                                          ConnLockingException,
                                                          ConnNotFoundException,
                                                          ConnSecurityException,
                                                          ConnTransportException,
                                                          ConnValidationException,
                                                          ConnEngineNotMasterException,
                                                          java.rmi.RemoteException
    This method performs the operations of makeJobInPlanIntoJobStreamInstance and addJobInstance in a single invokation, without allowing user manipulation of the object. This method is usefull for simple submission operations. This method can be invoked only on the master engine. This operation is not supported in z/OS environment.

    Parameters:
    jobDefinitionId - The database JobDefinition 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 jobDefinitionId,
                                     Identifier workstationId,
                                     java.lang.String alias,
                                     Context context)
                              throws ConnException,
                                     ConnLockingException,
                                     ConnNotFoundException,
                                     ConnSecurityException,
                                     ConnTransportException,
                                     ConnValidationException,
                                     ConnEngineNotMasterException,
                                     java.rmi.RemoteException
    This method performs the operations of makeJobInPlan and addJobInstance in a single invokation, without allowing user manipulation of the object. This method is usefull for simple submission operations. This method can be invoked only on the master engine.

    Parameters:
    jobDefinitionId - The database JobDefinition 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 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 performs the operations of makeJobStreamInPlan and addJobStreamInstance in a single invokation, without allowing user manipulation of the object. This method is usefull for simple submission operations. This method can be invoked only on the master engine.

    Parameters:
    jobStreamId - The database JobStream 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 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. The properties that can be changed through this method are:
  • JobInPlan.repeatInterval and consequently the flag JobInPlan.every
  • TimeRestrictions.untilTime and consequently the flag JobInPlan.untilUsed
  • TimeRestrictions.deadlineTime and consequently the flag JobStreamInPlan.deadlineUsed
  • TimeRestrictions.startTime
  • TimeRestrictions.latestStartAction
  • FlowNodeInFlan.priority and consequently the flag JobInPlan.heldByUser
  • JobInPlan.requiresConfirmation
  • FlowNodeInFlan.isMonitored
  • For the operation to succeed to Job should not be JobInPlan.canceled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. For the operation to succeed to Job Stream should not be JobStreamInPlan.cancelled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. For the operation to succeed to Job Stream should not be JobStreamInPlan.cancelled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. If a pending value equals to true is specified, instead of a normal cancel operation, a cancel pending operation is performed. The operation cannot be performed if the job stream is USERJOBS, JOBS or EXTERNAL.

    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. The dependencies specified are dependencies present on the job stream itself. 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.
    See Also:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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. The dependencies specified are dependencies present on the job stream itself. 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.
    See Also:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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. The dependencies specified are dependencies not present on the job stream itself. 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. The referenced FileInPlan objects could be still not present in the Plan.
    resourceDeps - A List of ResourceDependencyInPlan objects to be added. The referenced ResorceInPlan objects should be already present in the Plan.
    promptDeps - A List of PromptDependencyInPlan objects to be added. If the referenced PromptInPlan is predefined, it should be already present in the Plan; if it is an ad-hoc prompt it could be not.
    externalDeps - A List of ExternalDependencyInPlan objects to be added. The referenced objects (either JobInPlan or JobStreamInPlan) should be already present in the Plan.
    internetworkDeps - A List of InternetworkDependencyInPlan objects to be added. The referenced WorkstationInPlan objects should be already present in the Plan.
    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:
    FileDependencyInPlan, ResourceDependencyInPlan, PromptDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan

    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. Note that even if the method is defined on a Job Stream, the real action is performed on the Jobs, so the security checks will be done on them. For the operation to succeed to Job Stream should not be JobStreamInPlan.cancelled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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. The properties that can be changed through this method are:
  • JobStreamInPlan.limit
  • TimeRestrictions.untilTime and consequently the flag JobStreamInPlan.untilUsed
  • TimeRestrictions.deadlineTime and consequently the flag JobStreamInPlan.deadlineUsed
  • TimeRestrictions.startTime
  • FlowNodeInFlan.priority and consequently the flag JobStreamInPlan.heldByUser
  • JobInPlan.carryForward
  • FlowNodeInFlan.isMonitored
  • For the operation to succeed to Job Stream should not be JobStreamInPlan.cancelled and should not be in one of the following statuses:
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CANCEL
  • FlowNodeInternalStatusType.FLOW_NODE_STATUS_CNPEND
  • 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

    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. The property that can be changed through this method is:
  • ResourceInPlan.availableResources
  • 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.

    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.
    See Also:
    EngineInformation

    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. To simplify the iteration on the bunches the use of the GetJobOutputIterator is recommended.

    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. In almost every case it should be enough. To retrieve the next ones the method getJobInstanceOutput(GetJobOutputContext) should be used. To simplify the iteration on the bunches the use of the GetJobOutputIterator is recommended.

    Parameters:
    jobId - The identifier of the JobInPlan from which take the output.
    lines - The number of lines that should be returned in each call. If it is greater than the value set in the engine configuration file, this last value is used.
    context - The user context, or null if a default context is to be used.
    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.

    connectToHostCpu

    public byte[] connectToHostCpu(Identifier workstationId,
                                   java.lang.String connectionString,
                                   byte[] command,
                                   Context context)
                            throws ConnException,
                                   ConnLockingException,
                                   ConnNotFoundException,
                                   ConnSecurityException,
                                   ConnTransportException,
                                   ConnValidationException,
                                   java.rmi.RemoteException
    This method connects a remote workstation via TCP/IP (with options), sends a command to it, and receives the result from it. The entire result is returned in one call. This operation is not supported in z/OS environment.

    Parameters:
    workstationId - The WorkstationInPlan Identifier of the remote workstation.
    connectionString - a String contatining options for the TCP/IP connection.
    command - the command to be sent to the remote workstation (UTF-8).
    context - The user context, or null if a default context is to be used.
    Returns:
    a byte array containing the remote workstation response (UTF-8).
    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, depending on the type specified in the SymphonyInPlanKey, with the name specified in the key itself. 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. The only supported values for the type are:
  • SymphonyType.SYMPHONY_TYPE_TRIAL
  • SymphonyType.SYMPHONY_TYPE_FORECAST
  • 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.
    See Also:
    SymphonyType

    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. The only supported values for the type are:
  • SymphonyType.SYMPHONY_TYPE_TRIAL
  • SymphonyType.SYMPHONY_TYPE_FORECAST
  • 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.
    See Also:
    SymphonyType

    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 return 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. Valid values are:
  • DomainInPlan
  • FileInPlan
  • JobInPlan
  • JobStreamInPlan
  • PromptInPlan
  • ResourceInPlan
  • SymphonyInPlan
  • WindowsUserInPlan
  • WorkstationInPlan
  • 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.
    See Also:
    DomainInPlanFilters, FileInPlanFilters, JobInPlanFilters, JobStreamInPlanFilters, PromptInPlanFilters, ResourceInPlanFilters, SymphonyInPlanFilters, WindowsUserInPlanFilters, WorkstationInPlanFilters, QueryFilter


    Copyright © 2005 IBM All Rights Reserved.