com.ibm.tws.zconn.model
Interface ZConnModel


public interface ZConnModel

Remote interface of EJB


Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Method Summary
 Identifier addTWSObject(TWSObject twsObject, Context context)
          Add Object in TWS model
 TWSObject getTWSObject(java.lang.Class cl, Identifier id, boolean lock, Context context)
          This method return a TWSObject with the identifier passed in input
 TWSObject getTWSObject(java.lang.Class cl, TWSKey twsKey, boolean lock, Context context)
          This method return a TWSObject with the key passed in input
 java.lang.Boolean isWorkstation(Identifier[] id, FlowTargetKey[] key, Context context)
          Retrieves the type, identifier and key of a Workstation or WorkstationClass object.
 JobStatistics loadJobStatistics(Identifier jobDefinitionId, Context context)
          Load job definition statistcs object by job definition id.
 JobStatistics loadJobStatistics(JobDefinitionKey jobDefinitionKey, Context context)
          Load job definition statistcs object by job definition external key.
 void lockTWSObject(java.lang.Class cl, Identifier id, Context context)
          Locks the TWSObject object identified by the given id.
 void lockTWSObject(java.lang.Class cl, TWSKey twsKey, Context context)
          Locks the TWSObject object identified by the given key.
 QueryResult queryNext(QueryContext queryContext)
          Return a list of object according with the query context passed in input This list is contained in the QueryResult object
 QueryResult queryTWSObject(java.lang.Class cl, QueryFilter filter, int howMany, Context context)
          Return a list of object according with the Filter passed in input This list is contained in the QueryResult object
 void removeTWSObject(java.lang.Class cl, Identifier id, Context context)
          removeTWSObject
 void removeTWSObject(java.lang.Class cl, TWSKey twsKey, Context context)
          removeTWSObject
 Identifier setTWSObject(TWSObject daoobject, boolean isLocked, boolean unlock, Context context)
          This method update the TWSObject passed in input
 void unlockTWSObject(java.lang.Class cl, Identifier id, boolean force, Context context)
          Unlocks the TWSObject object identified by the given id.
 void unlockTWSObject(java.lang.Class cl, TWSKey twsKey, boolean force, Context context)
          Unlocks the TWSObject object identified by the given key.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright

Method Detail

addTWSObject

public Identifier addTWSObject(TWSObject twsObject,
                               Context context)
                        throws ConnException,
                               ConnLockingException,
                               ConnIntegrityException,
                               ConnTransportException,
                               ConnValidationException,
                               ConnSecurityException,
                               java.rmi.RemoteException
Add Object in TWS model

Parameters:
twsObject -
context -
Returns:
Identifier
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnLockingException - The whole database is locked.
ConnIntegrityException
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

removeTWSObject

public void removeTWSObject(java.lang.Class cl,
                            TWSKey twsKey,
                            Context context)
                     throws ConnException,
                            ConnIntegrityException,
                            ConnNotFoundException,
                            ConnLockingException,
                            ConnTransportException,
                            ConnValidationException,
                            ConnSecurityException,
                            java.rmi.RemoteException
removeTWSObject

Parameters:
cl -
twsKey -
context -
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnLockingException - The object is locked, or the whole database is locked.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
ConnIntegrityException - An object that is referenced by some other object cannot be deleted
java.rmi.RemoteException

removeTWSObject

public void removeTWSObject(java.lang.Class cl,
                            Identifier id,
                            Context context)
                     throws ConnException,
                            ConnIntegrityException,
                            ConnNotFoundException,
                            ConnLockingException,
                            ConnTransportException,
                            ConnValidationException,
                            ConnSecurityException,
                            java.rmi.RemoteException
removeTWSObject

Parameters:
cl -
id -
context -
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - The object is locked, or the whole database is locked.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

getTWSObject

public TWSObject getTWSObject(java.lang.Class cl,
                              TWSKey twsKey,
                              boolean lock,
                              Context context)
                       throws ConnException,
                              ConnIntegrityException,
                              ConnNotFoundException,
                              ConnLockingException,
                              ConnTransportException,
                              ConnValidationException,
                              ConnSecurityException,
                              java.rmi.RemoteException
This method return a TWSObject with the key passed in input

Parameters:
context -
twsKey -
cl -
lock - true if the object must be locked after the get.
Returns:
TWSObject
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
ConnIntegrityException - An object that is referenced by some other object cannot be deleted
java.rmi.RemoteException

getTWSObject

public TWSObject getTWSObject(java.lang.Class cl,
                              Identifier id,
                              boolean lock,
                              Context context)
                       throws ConnException,
                              ConnIntegrityException,
                              ConnNotFoundException,
                              ConnLockingException,
                              ConnTransportException,
                              ConnValidationException,
                              ConnSecurityException,
                              java.rmi.RemoteException
This method return a TWSObject with the identifier passed in input

Parameters:
cl -
id -
context -
lock - True if the object must be locked after the get.
Returns:
TWSObject
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

setTWSObject

public Identifier setTWSObject(TWSObject daoobject,
                               boolean isLocked,
                               boolean unlock,
                               Context context)
                        throws ConnException,
                               ConnIntegrityException,
                               ConnNotFoundException,
                               ConnLockingException,
                               ConnTransportException,
                               ConnValidationException,
                               ConnSecurityException,
                               java.rmi.RemoteException
This method update the TWSObject passed in input

Parameters:
daoobject -
isLocked - True if the object has been locked by the user, false if it is unlocked.
unlock - True if the object must be unlocked after applying the requested update.
context -
Returns:
The new identifier of the object
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - The object is not locked as expected, or the whole database is locked.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

queryTWSObject

public QueryResult queryTWSObject(java.lang.Class cl,
                                  QueryFilter filter,
                                  int howMany,
                                  Context context)
                           throws ConnException,
                                  ConnTransportException,
                                  ConnValidationException,
                                  ConnSecurityException,
                                  java.rmi.RemoteException
Return a list of object according with the Filter passed in input This list is contained in the QueryResult object

Parameters:
cl -
filter -
howMany -
context -
Returns:
ConnIterator
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

queryNext

public QueryResult queryNext(QueryContext queryContext)
                      throws ConnException,
                             ConnTransportException,
                             ConnValidationException,
                             ConnSecurityException,
                             java.rmi.RemoteException
Return a list of object according with the query context passed in input This list is contained in the QueryResult object

Parameters:
queryContext - This parameter contains the information retrieved from the preovious QueryNext or QueryTWSObject.
Returns:
QueryResult
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

lockTWSObject

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

Parameters:
cl - class of the DAO objects to be locked.
id - The identifier of the object to be locked.
context - containing userSession The session of the user who is requesting the lock, and lock True if the objects must be locked.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

lockTWSObject

public void lockTWSObject(java.lang.Class cl,
                          TWSKey twsKey,
                          Context context)
                   throws ConnException,
                          ConnIntegrityException,
                          ConnNotFoundException,
                          ConnLockingException,
                          ConnTransportException,
                          ConnValidationException,
                          ConnSecurityException,
                          java.rmi.RemoteException
Locks the TWSObject object identified by the given key.

Parameters:
cl - class of the DAO objects to be locked.
twsKey - The key of the object to be locked.
context - containing userSession The session of the user who is requesting the lock, and lock True if the objects must be locked.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to lock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

unlockTWSObject

public void unlockTWSObject(java.lang.Class cl,
                            Identifier id,
                            boolean force,
                            Context context)
                     throws ConnException,
                            ConnIntegrityException,
                            ConnNotFoundException,
                            ConnLockingException,
                            ConnTransportException,
                            ConnValidationException,
                            ConnSecurityException,
                            java.rmi.RemoteException
Unlocks the TWSObject object identified by the given id.

Parameters:
cl - class of the DAO objects to be unlocked.
id - The identifier of the object to be unlocked.
force - True if the object must be unlocked even if the user is different.
context - containing userSession The session of the user who is requesting the lock, and lock True if the objects must be locked.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to unlock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

unlockTWSObject

public void unlockTWSObject(java.lang.Class cl,
                            TWSKey twsKey,
                            boolean force,
                            Context context)
                     throws ConnException,
                            ConnIntegrityException,
                            ConnNotFoundException,
                            ConnLockingException,
                            ConnTransportException,
                            ConnValidationException,
                            ConnSecurityException,
                            java.rmi.RemoteException
Unlocks the TWSObject object identified by the given key.

Parameters:
cl - class of the DAO objects to be unlocked.
twsKey - The key of the object to be unlocked.
force - True if the object must be unlocked even if the user is different.
context - containing userSession The session of the user who is requesting the lock, and lock True if the objects must be locked.
Throws:
ConnException - A generic error has occurred in accessing the data.
ConnIntegrityException
ConnNotFoundException - The object was not found.
ConnLockingException - It has been impossible to unlock the object.
ConnTransportException - An error has occurred in accessing the data.
ConnValidationException - An error has occurred validating the data.
ConnSecurityException - A security error has occurred accessing the data.
java.rmi.RemoteException

loadJobStatistics

public JobStatistics loadJobStatistics(Identifier jobDefinitionId,
                                       Context context)
                                throws ConnNotFoundException,
                                       ConnException,
                                       java.rmi.RemoteException
Load job definition statistcs object by job definition id.

Parameters:
jobDefinitionId - The identifier of the job definition.
context - The user context, or null if a default context is to be used.
Returns:
job statistics
Throws:
ConnException - A problem has occurred, which is not one of those listed below.
ConnTransportException - A transport problem has been found in accessing the data.
ConnNotFoundException - The job definition identified by the given id was not found.
java.rmi.RemoteException

loadJobStatistics

public JobStatistics loadJobStatistics(JobDefinitionKey jobDefinitionKey,
                                       Context context)
                                throws ConnNotFoundException,
                                       ConnException,
                                       java.rmi.RemoteException
Load job definition statistcs object by job definition external key.

Parameters:
jobDefinitionKey - The external key of the job definition.
context - The user context, or null if a default context is to be used.
Returns:
job statistics
Throws:
ConnException - A problem has occurred, which is not one of those listed below.
ConnTransportException - A transport problem has been found in accessing the data.
ConnNotFoundException - The job definition identified by the given id was not found.
java.rmi.RemoteException

isWorkstation

public java.lang.Boolean isWorkstation(Identifier[] id,
                                       FlowTargetKey[] key,
                                       Context context)
                                throws ConnNotFoundException,
                                       ConnTransportException,
                                       ConnException,
                                       java.rmi.RemoteException
Retrieves the type, identifier and key of a Workstation or WorkstationClass object.

Parameters:
id - An input/output array of one element, including the identifier of the workstation or workstation class.
key - An input/output array of one element, including the key of the workstation or workstation class.
context - The user context, or null if a default context is to be used.
Returns:
True if the object retrieved is a workstation, false if it is a workstation class.
Throws:
ConnNotFoundException - The requested object was not found.
ConnTransportException - An error has occurred in accessing the data.
ConnException - A problem has occurred, which is not one of those listed above.
java.rmi.RemoteException


Copyright © 2005 IBM All Rights Reserved.