psdi.app.rsconfig

Interface RSConfigSetRemote

All Superinterfaces:

MboAccessInterface, MboSetRemote, java.rmi.Remote, Transactable

All Known Implementing Classes:

RSConfigSet

public interface RSConfigSetRemote
extends MboSetRemote

Remote Interface to the RSCONFIG set.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULTSETCOLS Relationship to the RESULTSETCOLS table, used to find the details for a given portlet layout.

Fields inherited from interface psdi.mbo.MboSetRemote

INSERTONLY, INSERTORUPDATE, UPDATEONLY

Method Summary

Modifier and Type	Method and Description
void	addFromResultSetColumn() Copy attributes from resultsetcols to rsconfig for the current selected application
void	addFromResultSetColumn(java.lang.String appName) Copy attributes from resultsetcols to rsconfig for a giving application name
void	checkAttributeChange() Checks if any attributes have changed in the Qery's App's Main object.
void	clearData() Clears the configuration details for this portlet
void	clearErrorMsg() Clears the error on the portlet
void	deleteLabels() Deletes labels related to this portlet when query is changed since portlet configuration is lost
java.util.Vector	getColumns() Returns a collection of attributes currently selected for display in the portlet
java.lang.String[]	getColumnsAsArray() Returns an array of names of the currently selected attributes for display in the portlet
java.lang.String	getConditionAttribute() Returns the name of the condition attribute on which a condition is set for color display
java.util.HashSet	getConditions() Returns the conditions set for this portlet. Methods are called on PortletDisplaySetRemote
java.util.ArrayList	getDataForGraph() Returns the data needed to display the charts. A SQL is formed in the following manner select GROUPBY /DISPLAY BY Attribute, count(*) from tablename where query where clause group by GROUPBY /DISPLAY BY Attribute Data is into an array list to be passed on the client side for graph generation The graph array list contains data as per following example Records NumberInformation (Hashtable) RSCONFIGIDUnique Id 1percent=50;value=WAPPR;count=5 2percent=50;value=APPR;count=5 java.lang.String getErrorMsg() Returns if there was a general error. java.util.Properties getGraphDetails() Returns the information relating to query and attribute on which grouping was done. java.lang.String getGraphErrorMsg() Returns if there was a general error with graph. java.lang.String[] getGroupByAttribute() Returns the name of the attribute on which data will be grouped by and graph has to be displayed java.lang.String getKeyColumn() Returns current unique attribute java.util.ArrayList getNonPersistentAttributes() Returns a collection of all non-persistent fields. This is needed in the portlet to restrict user from filtering. int getNoOfRecords() Returns no of records in this query java.lang.String getOriginalResultSetWhere() java.lang.String getQueryAppName() Returns the name of the application being used in this portlet currently java.lang.String getQueryId() Returns the ID of the query being used currently MboRemote getQueryInfo(long queryId) Returns the QueryRemote for the given query MboSetData getResultSetData(int start, int rowcount, java.lang.String sortBy, java.util.Hashtable qbes) Returns the MboValueData to be displayed on the portlet The data will be fetched for current query based on its where clause> Only records in the range given by start and rowcount will be fetched This method also takes into account specific cases of query belonging to WORKVIEW application. Data is filtered based on the qbes passed on by the user on the MboSetRemote getResultSetMboSet(java.lang.String sortBy) Returns a MboSetRemote for the Query for this result set. java.lang.String getResultSetWhere() java.lang.String getResultSetWhereWithoutOrderBy() boolean isErrorRunningQuery() Returns if there was an error running the query to fetch teh result set data. boolean queryExists() Returns true if the related query exists void resetErrorRunningQuery() Resets the query error flag to false. MboSetRemote runQuery(UserInfo userInfo, java.lang.String sTableName, java.lang.String sWhereClause) Runs the current query and returns the set of data based on the given where clause boolean setDetails(long queryId) Called when a query is selected for Portlet configuration. Sets the complete details based on the query id Main steps are Get application name for this query Set query name in the portlet Set attributes for the application of this query into this portlet void setKeyColumn(java.lang.String col) Sets current unique attribute for portlet linking void setLookupValue(java.lang.String attrib, java.lang.String value) Sets the attribute name that was selected from lookup for condition or graph configuration void setLookupValueFromSetGraphOptionsDialog(java.lang.String value) Determines if the dot notation field is persistent. void setNoOfRecords(int num) Returns no of records void setQueryAppName(java.lang.String newApp) Sets the currently used application void setQueryId(java.lang.String newQueryId) Sets the selected Query Id void setUpDefaults() Sets default values for virtual attributes and class variables Methods inherited from interface psdi.mbo.MboSetRemote abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addWarning, addWarnings, checkMethodAccess, cleanup, clear, clearLongOpPipe, close, commit, copy, copy, copyForDM, count, count, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, earliestDate, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, getApp, getAppAlwaysFieldFlags, getAppWhere, getCompleteWhere, getCurrentPosition, getDBFetchMaxRows, getDefaultValue, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getKeyAttributes, getList, getList, getMaxMessage, getMbo, getMbo, getMboForUniqueId, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getProfile, getQbe, getQbe, getQbe, getQbeWhere, getQueryTimeout, getRelationName, getRelationship, getSelection, getSelectionWhere, getSetOrderByForUI, getSize, getSQLOptions, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserWhere, getWarnings, getWhere, getZombie, hasMLQbe, hasQbe, hasWarnings, ignoreQbeExactMatchSet, incrementDeletedCount, init, isBasedOn, isDMDeploySet, isDMSkipFieldValidation, isEmpty, isESigNeeded, isFlagSet, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, latestDate, locateMbo, logESigVerification, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, newMboIndex, notExist, positionState, processML, remove, remove, remove, reset, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, save, save, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboSetInfo, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOwner, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, startCheckpoint, startCheckpoint, sum, toBeSaved, undeleteAll, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, verifyESig Methods inherited from interface psdi.mbo.MboAccessInterface getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getString, isNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull Methods inherited from interface psdi.txn.Transactable commitTransaction, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, rollbackTransaction, saveTransaction, undoTransaction, validateTransaction Field Detail RESULTSETCOLS static final java.lang.String RESULTSETCOLS Relationship to the RESULTSETCOLS table, used to find the details for a given portlet layout. The resulting set will contain one or more objects See Also: Constant Field Values Method Detail deleteLabels void deleteLabels() throws java.rmi.RemoteException, MXException Deletes labels related to this portlet when query is changed since portlet configuration is lost Throws: java.rmi.RemoteException MXException getColumns java.util.Vector getColumns() throws java.rmi.RemoteException, MXException Returns a collection of attributes currently selected for display in the portlet Returns: collection of array of names and description for selected attributes Throws: java.rmi.RemoteException MXException getQueryId java.lang.String getQueryId() throws java.rmi.RemoteException, MXException Returns the ID of the query being used currently Returns: String Id of the selected query Throws: java.rmi.RemoteException MXException setQueryId void setQueryId(java.lang.String newQueryId) throws java.rmi.RemoteException, MXException Sets the selected Query Id Parameters: = - newQueryId new selected Query Id Throws: java.rmi.RemoteException MXException getQueryAppName java.lang.String getQueryAppName() throws java.rmi.RemoteException, MXException Returns the name of the application being used in this portlet currently Returns: String Name of related application Throws: java.rmi.RemoteException MXException setQueryAppName void setQueryAppName(java.lang.String newApp) throws java.rmi.RemoteException, MXException Sets the currently used application Parameters: newAppName - as the applications Throws: java.rmi.RemoteException MXException getColumnsAsArray java.lang.String[] getColumnsAsArray() throws java.rmi.RemoteException, MXException Returns an array of names of the currently selected attributes for display in the portlet Returns: String[] of names of the attributes Throws: java.rmi.RemoteException MXException runQuery MboSetRemote runQuery(UserInfo userInfo, java.lang.String sTableName, java.lang.String sWhereClause) throws java.rmi.RemoteException, MXException Runs the current query and returns the set of data based on the given where clause Parameters: UserInfo - current user info sTableName - object name sWhereClause - where clause for the query Returns: MboSetRemote of given table based in give whereclause Throws: java.rmi.RemoteException MXException getResultSetData MboSetData getResultSetData(int start, int rowcount, java.lang.String sortBy, java.util.Hashtable qbes) throws java.rmi.RemoteException, MXException Returns the MboValueData to be displayed on the portlet The data will be fetched for current query based on its where clause> Only records in the range given by start and rowcount will be fetched This method also takes into account specific cases of query belonging to WORKVIEW application. Data is filtered based on the qbes passed on by the user on the Parameters: start - position rows - to display sort - by hashtable - of qbes Throws: java.rmi.RemoteException MXException getResultSetWhere java.lang.String getResultSetWhere() throws java.rmi.RemoteException Returns: The full where clause used by the last getResultSetData call Throws: java.rmi.RemoteException getResultSetWhereWithoutOrderBy java.lang.String getResultSetWhereWithoutOrderBy() throws java.rmi.RemoteException Returns: The full where clause used by the last getResultSetData call but without any orderby 08-21287 Throws: java.rmi.RemoteException getOriginalResultSetWhere java.lang.String getOriginalResultSetWhere() throws java.rmi.RemoteException Returns: The original where clause passed to the data set to retrieve the records. Note that this has the orderby portion of the where clause removed. Throws: java.rmi.RemoteException getKeyColumn java.lang.String getKeyColumn() throws java.rmi.RemoteException, MXException Returns current unique attribute Returns: name of the unique attribute as String Throws: java.rmi.RemoteException MXException getNoOfRecords int getNoOfRecords() throws java.rmi.RemoteException, MXException Returns no of records in this query Returns: number of records as integer Throws: java.rmi.RemoteException MXException setKeyColumn void setKeyColumn(java.lang.String col) throws java.rmi.RemoteException, MXException Sets current unique attribute for portlet linking Parameters: unique - attribute name as String Throws: java.rmi.RemoteException MXException setNoOfRecords void setNoOfRecords(int num) throws java.rmi.RemoteException, MXException Returns no of records Throws: java.rmi.RemoteException MXException setDetails boolean setDetails(long queryId) throws java.rmi.RemoteException, MXException Called when a query is selected for Portlet configuration. Sets the complete details based on the query id Main steps are Get application name for this query Set query name in the portlet Set attributes for the application of this query into this portlet Returns: true of portlet wa configured with new query Throws: java.rmi.RemoteException MXException clearData void clearData() throws java.rmi.RemoteException, MXException Clears the configuration details for this portlet Throws: java.rmi.RemoteException MXException getQueryInfo MboRemote getQueryInfo(long queryId) throws java.rmi.RemoteException, MXException Returns the QueryRemote for the given query Returns: query Id as long Throws: java.rmi.RemoteException MXException getConditionAttribute java.lang.String getConditionAttribute() throws java.rmi.RemoteException, MXException Returns the name of the condition attribute on which a condition is set for color display Returns: name of the attribute as String Throws: java.rmi.RemoteException MXException getGroupByAttribute java.lang.String[] getGroupByAttribute() throws java.rmi.RemoteException, MXException Returns the name of the attribute on which data will be grouped by and graph has to be displayed Returns: name of the attribute as String Throws: java.rmi.RemoteException MXException getConditions java.util.HashSet getConditions() throws java.rmi.RemoteException, MXException Returns the conditions set for this portlet. Methods are called on PortletDisplaySetRemote Returns: Conditions set as HashSet Throws: java.rmi.RemoteException MXException getDataForGraph java.util.ArrayList getDataForGraph() throws java.rmi.RemoteException, MXException Returns the data needed to display the charts. A SQL is formed in the following manner select GROUPBY /DISPLAY BY Attribute, count(*) from tablename where query where clause group by GROUPBY /DISPLAY BY Attribute Data is into an array list to be passed on the client side for graph generation The graph array list contains data as per following example Records Number Information (Hashtable) RSCONFIGID Unique Id 1 percent=50;value=WAPPR;count=5 2 percent=50;value=APPR;count=5 Returns: graph plotting data as array list Throws: java.rmi.RemoteException MXException getGraphDetails java.util.Properties getGraphDetails() throws java.rmi.RemoteException, MXException Returns the information relating to query and attribute on which grouping was done. This will be used in displaying the graph. Returns: graph information as Properties Throws: java.rmi.RemoteException MXException setUpDefaults void setUpDefaults() throws java.rmi.RemoteException, MXException Sets default values for virtual attributes and class variables Throws: java.rmi.RemoteException MXException queryExists boolean queryExists() throws java.rmi.RemoteException, MXException Returns true if the related query exists Throws: java.rmi.RemoteException MXException checkAttributeChange void checkAttributeChange() throws java.rmi.RemoteException, MXException Checks if any attributes have changed in the Qery's App's Main object. This ahs to be done so that newly added persistent fields are available for configuration Throws: java.rmi.RemoteException MXException isErrorRunningQuery boolean isErrorRunningQuery() throws java.rmi.RemoteException, MXException Returns if there was an error running the query to fetch teh result set data. Returns: Throws: java.rmi.RemoteException MXException resetErrorRunningQuery void resetErrorRunningQuery() throws java.rmi.RemoteException, MXException Resets the query error flag to false. Throws: java.rmi.RemoteException MXException getErrorMsg java.lang.String getErrorMsg() throws java.rmi.RemoteException, MXException Returns if there was a general error. Returns: Throws: java.rmi.RemoteException MXException getGraphErrorMsg java.lang.String getGraphErrorMsg() throws java.rmi.RemoteException, MXException Returns if there was a general error with graph. Returns: Throws: java.rmi.RemoteException MXException setLookupValue void setLookupValue(java.lang.String attrib, java.lang.String value) throws java.rmi.RemoteException, MXException Sets the attribute name that was selected from lookup for condition or graph configuration Throws: java.rmi.RemoteException MXException setLookupValueFromSetGraphOptionsDialog void setLookupValueFromSetGraphOptionsDialog(java.lang.String value) throws java.rmi.RemoteException, MXException Determines if the dot notation field is persistent. This method is called from Set Graph options dialog and from Graph Options tab inside RS Config App Parameters: layoutid - PortletId fieldName - Attribute selected userinfo - UserInfo Throws: java.rmi.RemoteException MXException getNonPersistentAttributes java.util.ArrayList getNonPersistentAttributes() throws java.rmi.RemoteException, MXException Returns a collection of all non-persistent fields. This is needed in the portlet to restrict user from filtering. Returns: ArrayList of attribute names Throws: java.rmi.RemoteException MXException clearErrorMsg void clearErrorMsg() throws java.rmi.RemoteException Clears the error on the portlet Throws: java.rmi.RemoteException addFromResultSetColumn void addFromResultSetColumn() throws java.rmi.RemoteException, MXException Copy attributes from resultsetcols to rsconfig for the current selected application Throws: java.rmi.RemoteException MXException addFromResultSetColumn void addFromResultSetColumn(java.lang.String appName) throws java.rmi.RemoteException, MXException Copy attributes from resultsetcols to rsconfig for a giving application name Parameters: - - giving app Name Throws: java.rmi.RemoteException MXException getResultSetMboSet MboSetRemote getResultSetMboSet(java.lang.String sortBy) throws java.rmi.RemoteException, MXException Returns a MboSetRemote for the Query for this result set. It always uses the current completewhereclause, so getResultSetData must be called before this. Parameters: sortBy - Returns: Throws: java.rmi.RemoteException MXException Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method