sapphire.accessor

Class DAMProcessor

java.lang.Object

com.labvantage.sapphire.BaseClass

com.labvantage.sapphire.BaseAccessor

sapphire.accessor.DAMProcessor

public class DAMProcessor
extends com.labvantage.sapphire.BaseAccessor

Supports SDCManager access and related functions

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseAccessor

jndiPrefix, local, localJNDIPrefix, remoteAccessKey

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
DAMProcessor(java.io.File rakFile, java.lang.String connectionid) Constructor for a client application with an existing connection
DAMProcessor(javax.servlet.jsp.PageContext pageContext) Constructor for a client web application with a page Context and existing connectionid
DAMProcessor(java.lang.String connectionid) Constructor for creating an accessor from components
DAMProcessor(java.lang.String nameserverlist, java.lang.String connectionid) Deprecated.

Method Summary

Modifier and Type	Method and Description
SDIList	checkSDIAccess(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, boolean viewHiddenRecord, java.lang.String operation) Method checks if the current user has access to the provided set of SDIs.
int	clearRSet(java.lang.String rsetid) Clears a specified RSet
java.lang.String	createLockedRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list) Create a new RSet with lock
int	createLockedRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
java.lang.String	createLockedRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch) Create a new DS RSet with lock
int	createLockedRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
java.lang.String	createRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list) Create a new RSet with no lock
java.lang.String	createRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, boolean viewHiddenRecord, int bypassSecurityCode) Create a new RSet with no lock
int	createRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
java.lang.String	createRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch) Create a new DS RSet with lock
java.lang.String	createRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch, boolean populateBoth, boolean calcexpand) Create a new DS RSet with lock
int	createRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch, boolean populateBoth, boolean calcexpand, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
int	createRSetDS(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String paramlistidlist, java.lang.String paramlistversionidlist, java.lang.String variantidlist, java.lang.String datasetlist, boolean propsMatch, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
java.lang.String	createRSetQ(java.lang.String sdcid, java.lang.String queryid, java.lang.String[] params) Create a new RSet with no lock
java.lang.String	createRSetQ(java.lang.String sdcid, java.lang.String queryid, java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.String param4, java.lang.String param5) Create a new RSet with no lock
int	createRSetQ(java.lang.String sdcid, java.lang.String queryid, java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.String param4, java.lang.String param5, org.omg.CORBA.StringHolder rsetidholder) Deprecated.
java.lang.String	createRSetWI(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list, java.lang.String workitemidlist, java.lang.String workiteminstancelist, boolean populateBoth) Create a new WI RSet
java.lang.String	getAllDSRSet(java.lang.String sdcid, java.lang.String keyid1list, java.lang.String keyid2list, java.lang.String keyid3list) Create a new DS RSet for the SDIs.
boolean	isGlobalLock()
java.lang.String	lockRSet(java.lang.String rsetid) Applys a lock to an existing rset
int	lockRSet(org.omg.CORBA.StringHolder rsetidholder) Deprecated.
boolean	setGlobalLock(boolean lock)
void	touchRSet(java.lang.String rsetid) Pings a locked rset to keep the lock alive

Methods inherited from class com.labvantage.sapphire.BaseAccessor

createRemoteAccessKey, getAttachmentManager, getAutomationManager, getConfigurationManager, getConnectionid, getErrorCodeList, getErrorCodeStack, getErrorHandler, getErrorStack, getErrorStack, getErrorString, getInfoErrorString, getLastError, getLastErrorCode, getLastErrorMessage, getLastException, getLocalAccessManager, getNameserverlist, getQueryManager, getRemoteAccessManager, getRequestManager, getStatusManager, getWebAdminManager, hasErrors, hasInfoErrors, parseServiceExceptionMsg, resetConnectionid, resetErrorStack, setConnectionDetails, setConnectionid, setError, setError, setErrorString, setInfoErrorString, setJNDIPrefix, setLocal, setLocalJNDIPrefix, setRakFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DAMProcessor

public DAMProcessor(java.lang.String connectionid)

Constructor for creating an accessor from components

Parameters:

connectionid - The connection to use for component calls

DAMProcessor

public DAMProcessor(java.lang.String nameserverlist,
                    java.lang.String connectionid)

Deprecated.

Constructor for a client application with an existing connection

Parameters:

nameserverlist - list of the application sever names

connectionid - A valid connectionid

DAMProcessor

public DAMProcessor(java.io.File rakFile,
                    java.lang.String connectionid)

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

connectionid - A valid connectionid

DAMProcessor

public DAMProcessor(javax.servlet.jsp.PageContext pageContext)

Constructor for a client web application with a page Context and existing connectionid

Parameters:

pageContext - The current page context

Method Detail

clearRSet

public int clearRSet(java.lang.String rsetid)

Clears a specified RSet

Parameters:

rsetid - the RSet to clear

Returns:

SUCCESS / FAILURE

touchRSet

public void touchRSet(java.lang.String rsetid)

Pings a locked rset to keep the lock alive

Parameters:

rsetid - the RSet to ping

createRSet

public int createRSet(java.lang.String sdcid,
                      java.lang.String keyid1list,
                      java.lang.String keyid2list,
                      java.lang.String keyid3list,
                      org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createRSet

public java.lang.String createRSet(java.lang.String sdcid,
                                   java.lang.String keyid1list,
                                   java.lang.String keyid2list,
                                   java.lang.String keyid3list)
                            throws SapphireException

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSet

public java.lang.String createRSet(java.lang.String sdcid,
                                   java.lang.String keyid1list,
                                   java.lang.String keyid2list,
                                   java.lang.String keyid3list,
                                   boolean viewHiddenRecord,
                                   int bypassSecurityCode)
                            throws SapphireException

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

viewHiddenRecord - whether to include hidden(activeflag=N) SDIs

bypassSecurityCode - bypassSecurityCode, 0, 1 or 2.

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSetQ

public int createRSetQ(java.lang.String sdcid,
                       java.lang.String queryid,
                       java.lang.String param1,
                       java.lang.String param2,
                       java.lang.String param3,
                       java.lang.String param4,
                       java.lang.String param5,
                       org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

queryid - a sapphire queryid

param1 - parameter 1 for the query

param2 - parameter 2 for the query

param3 - parameter 3 for the query

param4 - parameter 4 for the query

param5 - parameter 5 for the query

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createRSetQ

public java.lang.String createRSetQ(java.lang.String sdcid,
                                    java.lang.String queryid,
                                    java.lang.String param1,
                                    java.lang.String param2,
                                    java.lang.String param3,
                                    java.lang.String param4,
                                    java.lang.String param5)
                             throws SapphireException

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

queryid - a sapphire queryid

param1 - parameter 1 for the query

param2 - parameter 2 for the query

param3 - parameter 3 for the query

param4 - parameter 4 for the query

param5 - parameter 5 for the query

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSetQ

public java.lang.String createRSetQ(java.lang.String sdcid,
                                    java.lang.String queryid,
                                    java.lang.String[] params)
                             throws SapphireException

Create a new RSet with no lock

Parameters:

sdcid - the SDC of the SDIs

queryid - a sapphire queryid

params - list of parameters for the query

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createLockedRSet

public int createLockedRSet(java.lang.String sdcid,
                            java.lang.String keyid1list,
                            java.lang.String keyid2list,
                            java.lang.String keyid3list,
                            org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createLockedRSet

public java.lang.String createLockedRSet(java.lang.String sdcid,
                                         java.lang.String keyid1list,
                                         java.lang.String keyid2list,
                                         java.lang.String keyid3list)
                                  throws SapphireException

Create a new RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSetDS

public int createRSetDS(java.lang.String sdcid,
                        java.lang.String keyid1list,
                        java.lang.String keyid2list,
                        java.lang.String keyid3list,
                        java.lang.String paramlistidlist,
                        java.lang.String paramlistversionidlist,
                        java.lang.String variantidlist,
                        java.lang.String datasetlist,
                        boolean propsMatch,
                        org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createRSetDS

public java.lang.String createRSetDS(java.lang.String sdcid,
                                     java.lang.String keyid1list,
                                     java.lang.String keyid2list,
                                     java.lang.String keyid3list,
                                     java.lang.String paramlistidlist,
                                     java.lang.String paramlistversionidlist,
                                     java.lang.String variantidlist,
                                     java.lang.String datasetlist,
                                     boolean propsMatch)
                              throws SapphireException

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSetDS

public int createRSetDS(java.lang.String sdcid,
                        java.lang.String keyid1list,
                        java.lang.String keyid2list,
                        java.lang.String keyid3list,
                        java.lang.String paramlistidlist,
                        java.lang.String paramlistversionidlist,
                        java.lang.String variantidlist,
                        java.lang.String datasetlist,
                        boolean propsMatch,
                        boolean populateBoth,
                        boolean calcexpand,
                        org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

populateBoth - inidcates that both the rsetitemsds AND rsetitems tables should be populated

calcexpand - inidcates that the calc dependent datasets should be included included in the RSet

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createRSetDS

public java.lang.String createRSetDS(java.lang.String sdcid,
                                     java.lang.String keyid1list,
                                     java.lang.String keyid2list,
                                     java.lang.String keyid3list,
                                     java.lang.String paramlistidlist,
                                     java.lang.String paramlistversionidlist,
                                     java.lang.String variantidlist,
                                     java.lang.String datasetlist,
                                     boolean propsMatch,
                                     boolean populateBoth,
                                     boolean calcexpand)
                              throws SapphireException

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

populateBoth - inidcates that both the rsetitemsds AND rsetitems tables should be populated

calcexpand - inidcates that the calc dependent datasets should be included included in the RSet

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

getAllDSRSet

public java.lang.String getAllDSRSet(java.lang.String sdcid,
                                     java.lang.String keyid1list,
                                     java.lang.String keyid2list,
                                     java.lang.String keyid3list)
                              throws SapphireException

Create a new DS RSet for the SDIs. This method bypasses primary security and observes dataset security if the DataSet SDC has security as 'departmental'.

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createRSetWI

public java.lang.String createRSetWI(java.lang.String sdcid,
                                     java.lang.String keyid1list,
                                     java.lang.String keyid2list,
                                     java.lang.String keyid3list,
                                     java.lang.String workitemidlist,
                                     java.lang.String workiteminstancelist,
                                     boolean populateBoth)
                              throws SapphireException

Create a new WI RSet

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

workitemidlist - semi-colon separated list of workitemid

workiteminstancelist - semi-colon separated list of workiteminstance

populateBoth - inidcates that both the rsetitemsds AND rsetitems tables should be populated

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

createLockedRSetDS

public int createLockedRSetDS(java.lang.String sdcid,
                              java.lang.String keyid1list,
                              java.lang.String keyid2list,
                              java.lang.String keyid3list,
                              java.lang.String paramlistidlist,
                              java.lang.String paramlistversionidlist,
                              java.lang.String variantidlist,
                              java.lang.String datasetlist,
                              boolean propsMatch,
                              org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

rsetidholder - holder containing the RSet identifier that has been created.

Returns:

SUCCESS / FAILURE

createLockedRSetDS

public java.lang.String createLockedRSetDS(java.lang.String sdcid,
                                           java.lang.String keyid1list,
                                           java.lang.String keyid2list,
                                           java.lang.String keyid3list,
                                           java.lang.String paramlistidlist,
                                           java.lang.String paramlistversionidlist,
                                           java.lang.String variantidlist,
                                           java.lang.String datasetlist,
                                           boolean propsMatch)
                                    throws SapphireException

Create a new DS RSet with lock

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the DS RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the DS RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the DS RSet.

paramlistidlist - semi-colon separated list of parameter lists to put into the DS RSet.

paramlistversionidlist - semi-colon separated list of parameter list versions to put into the DS RSet.

variantidlist - semi-colon separated list of parameter list variants to put into the DS RSet.

datasetlist - semi-colon separated list of datasets to put into the DS RSet.

propsMatch - inidcates if the property lists match

Returns:

rsetid the newly created locked rset

Throws:

SapphireException

lockRSet

public int lockRSet(org.omg.CORBA.StringHolder rsetidholder)

Deprecated.

Applys a lock to an existing rset

Parameters:

rsetidholder - holder containing the RSet.

Returns:

SUCCESS / FAILURE

lockRSet

public java.lang.String lockRSet(java.lang.String rsetid)
                          throws SapphireException

Applys a lock to an existing rset

Parameters:

rsetid - The rset to lock

Throws:

SapphireException

checkSDIAccess

public SDIList checkSDIAccess(java.lang.String sdcid,
                              java.lang.String keyid1list,
                              java.lang.String keyid2list,
                              java.lang.String keyid3list,
                              boolean viewHiddenRecord,
                              java.lang.String operation)
                       throws SapphireException

Method checks if the current user has access to the provided set of SDIs. The check is based on the SDCs access control settings.

Parameters:

sdcid - the SDC of the SDIs

keyid1list - semi-colon separated list of first key column of SDIs to put into the RSet.

keyid2list - semi-colon separated list of second key column of SDIs to put into the RSet.

keyid3list - semi-colon separated list of third key column of SDIs to put into the RSet.

viewHiddenRecord - whether to include hidden(activeflag=N) SDIs

operation - the sdcoperation which needs to be checked. For e.g. - list, edit.

Returns:

filtered list of SDIs which passed the access check.

Throws:

SapphireException

setGlobalLock

public boolean setGlobalLock(boolean lock)

isGlobalLock

public boolean isGlobalLock()