|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CLBrowser
This interface is the facade of the OMS Data Access Layer. It provides access to the following features: 1) Application Metadata (AppVO) 2) Methods to query and update the database, to obtain primary keys, etc. 3) Methods to access OMS-OLAPI features such as Descriptions, Lists, Config Items, Authentication. 4) Methods to get/set connection properties (setters for internal use only).
AppVO
Nested Class Summary | |
---|---|
static class |
CLBrowser.AuthState
|
Field Summary | |
---|---|
static java.lang.String |
CONFIG_FILE
|
static java.lang.String |
KEY_APP_PASS
|
static java.lang.String |
KEY_APP_USER
|
static java.lang.String |
KEY_DB_DATABASE
|
static java.lang.String |
KEY_DB_PASS
|
static java.lang.String |
KEY_DB_PORT
|
static java.lang.String |
KEY_DB_SCHEMA
|
static java.lang.String |
KEY_DB_SERV
|
static java.lang.String |
KEY_DB_TYPE
|
static java.lang.String |
KEY_DB_USER
|
static java.lang.String |
KEY_OL_SCH_FILE
|
Method Summary | |
---|---|
CLBrowser.AuthState |
authenticate(java.lang.String user,
java.lang.String pass)
|
boolean |
changePassword(java.lang.String user,
java.lang.String pass,
java.lang.String newpass)
|
long |
create(Instance i)
|
java.lang.Long |
createDescriptionId()
|
DescriptionVO |
createDescriptionVO(java.lang.String lang,
long descId,
java.lang.String domain,
java.lang.String name,
java.lang.String description,
java.lang.String shortDescription,
java.lang.String comments)
|
DescriptionVO |
createDescriptionVO(java.lang.String domain,
java.lang.String name)
|
DescriptionVO |
createDescriptionVO(java.lang.String domain,
java.lang.String name,
java.lang.String description)
|
DescriptionVO |
createDescriptionVO(java.lang.String domain,
java.lang.String name,
java.lang.String description,
java.lang.String shortDescription,
java.lang.String comments)
|
int |
delete(Instance i)
|
boolean |
doRefresh()
|
boolean |
doRefresh(boolean askServerRefresh)
|
boolean |
doRefresh(java.lang.Boolean askServerRefresh)
|
java.lang.String |
echo(java.lang.String challenge)
|
DataInstanceSet |
executeQuery(SelectQuery q,
boolean formattedValues)
|
DataInstanceSet |
executeQuery(SelectQuery q,
java.lang.Boolean formattedValues)
|
DataInstanceSet |
executeQuery(java.lang.String classname,
SelectQuery q)
"@deprecated |
InstanceSet |
executeText(java.lang.String text)
Executes any SQL command, use when data results are expected. |
void |
executeTextNoReturn(java.lang.String text)
Executes any SQL command, use when no results are expected. |
java.lang.Class |
findClass(java.lang.String classname)
|
AppVO |
getApp()
|
java.lang.String |
getAuthType()
|
java.lang.String |
getBytecode(java.lang.String classname)
|
ClassVO |
getClass(long classid)
|
ClassVO |
getClass(java.lang.String classname)
|
InstanceSet |
getConfigItems(java.lang.String configSet,
java.lang.String configItem)
|
java.lang.String |
getConfigItemValue(java.lang.String configSet,
java.lang.String configItem)
|
java.lang.String |
getConfigItemValue(java.lang.String configSet,
java.lang.String configItem,
java.lang.String defaultValue)
|
java.lang.String |
getDatabaseName()
|
java.lang.String |
getDbType()
|
java.lang.String[] |
getDBTypes()
|
RoleVO |
getDefaultRole()
|
DescriptionVO |
getDescriptionVO(long descId)
|
DescriptionVO |
getDescriptionVO(java.lang.Long descId)
|
DescriptionVO |
getDescriptionVO(java.lang.String domain,
java.lang.String name)
|
DescriptionVO |
getDescriptionVOFromDB(long descId,
java.lang.String lang)
|
DescriptionVO |
getDescriptionVOFromDB(java.lang.Long descId,
java.lang.String lang)
|
DescriptionVO |
getDescriptionVOFromDB(java.lang.String domain,
java.lang.String name,
java.lang.String lang)
|
javax.swing.Icon |
getIcon(java.lang.String classname)
|
Instance |
getInstance(Instance instance)
|
Instance |
getInstance(long classid,
long oid)
|
Instance |
getInstance(long classid,
java.lang.String propertyname,
java.lang.String value)
|
Instance |
getInstance(java.lang.String classname,
long oid)
|
Instance |
getInstance(java.lang.String classname,
java.lang.String propertyname,
java.lang.String value)
|
java.lang.Long |
getInstanceCount(java.lang.String classname,
java.lang.String filter,
int operator,
java.lang.String value)
|
InstanceSet |
getInstances(java.lang.String string)
|
InstanceSet |
getInstanceSet(long classid,
java.lang.String propertyname,
java.lang.String value)
|
InstanceSet |
getInstanceSet(java.lang.String classname,
java.lang.String filter,
int operator,
java.lang.Object val)
|
InstanceSet |
getInstanceSet(java.lang.String classname,
java.lang.String propertyname,
java.lang.String value)
|
InstanceSet |
getInstanceSetValidStatus(java.lang.String classname,
java.lang.String propertyname,
int operator,
java.lang.Object value,
boolean bValidStatus)
|
InstanceSet |
getInstanceSetValidStatus(java.lang.String classname,
java.lang.String filter,
java.lang.String value,
boolean bValidStatus)
|
ListType |
getListById(long listId)
|
ListVO |
getListByName(java.lang.String listName)
|
ListVO |
getListByParent(ListElmVO listElmVO)
|
ListVO[] |
getLists()
|
java.lang.String |
getMode()
|
java.lang.Object |
getPerfStats()
|
java.lang.String |
getPort()
|
long |
getPrimaryKeys(java.lang.String type,
java.lang.String classname,
java.lang.Integer num)
|
PropertyVO |
getProperty(java.lang.String classname,
java.lang.String propertyname)
|
RelationVO |
getRelation(ClassVO c,
PropertyVO p)
|
RelationVO |
getRelation(java.lang.String relname)
|
byte[] |
getResourceBytes(java.lang.String uri)
|
java.lang.String |
getSchema()
|
ListType |
getSelectedListVO(Instance inst,
int col)
Returns the ListVO associated with a list value in a given data instance. |
java.lang.String |
getSerial()
|
java.lang.String |
getServer()
|
long |
getVersion()
|
void |
impersonate(java.lang.String user,
java.lang.String pass)
|
boolean |
isEnableFilterInactiveStates()
|
Instance |
newInstance(java.lang.String classname)
|
boolean |
resetUserPassword(java.lang.String adminuser,
java.lang.String adminpass,
java.lang.String user,
java.lang.String newpass)
|
void |
saveAppVO()
|
void |
saveAppVO(AppVO newAppVO)
|
int |
saveFile(java.lang.String filename,
java.lang.String scontent,
ClassVO classvo,
Instance instance)
|
boolean |
saveList(ListVO list)
|
void |
setAutomaticFields(Instance instance)
|
void |
setDatabaseName(java.lang.String database)
|
void |
setDbType(java.lang.String schema)
|
void |
setDescription(ClassVO clsvo,
DescriptionVO descvo)
|
void |
setDescription(PropertyVO propvo,
DescriptionVO descvo)
|
void |
setDescription(RelationVO propvo,
DescriptionVO descvo)
|
void |
setEnableFilterInactiveStates(boolean enableFilterInactiveStates)
|
void |
setPort(java.lang.String port)
|
void |
setSchema(java.lang.String schema)
|
void |
setServer(java.lang.String server)
|
boolean |
unlockAccount(java.lang.String adminuser,
java.lang.String adminpass,
java.lang.String user)
|
int |
update(Instance i)
|
DescriptionVO |
updateDescriptionVO(DescriptionVO descvo,
java.lang.String domain,
java.lang.String name,
java.lang.String description,
java.lang.String shortDescription,
java.lang.String comments)
|
int |
updateModelVersion()
|
ValidationVO |
validate(Instance instance)
|
int |
verifyMandatory(Instance i)
|
Field Detail |
---|
static final java.lang.String CONFIG_FILE
static final java.lang.String KEY_OL_SCH_FILE
static final java.lang.String KEY_DB_TYPE
static final java.lang.String KEY_DB_SERV
static final java.lang.String KEY_DB_PORT
static final java.lang.String KEY_DB_DATABASE
static final java.lang.String KEY_DB_SCHEMA
static final java.lang.String KEY_DB_USER
static final java.lang.String KEY_DB_PASS
static final java.lang.String KEY_APP_USER
static final java.lang.String KEY_APP_PASS
Method Detail |
---|
java.lang.String getServer()
java.lang.String getPort()
java.lang.String getDatabaseName()
java.lang.String getMode()
java.lang.String getDbType()
java.lang.String[] getDBTypes() throws ConfigException
ConfigException
void setServer(java.lang.String server)
void setPort(java.lang.String port)
void setDatabaseName(java.lang.String database)
void setSchema(java.lang.String schema)
void setDbType(java.lang.String schema)
AppVO getApp()
long getVersion() throws java.sql.SQLException, java.rmi.RemoteException, QueryTreeException, ConnectionException, DataModelException
java.sql.SQLException
java.rmi.RemoteException
QueryTreeException
ConnectionException
DataModelException
ClassVO getClass(java.lang.String classname)
ClassVO getClass(long classid)
PropertyVO getProperty(java.lang.String classname, java.lang.String propertyname)
long create(Instance i) throws java.sql.SQLException, java.rmi.RemoteException, DataException
java.sql.SQLException
java.rmi.RemoteException
DataException
int delete(Instance i) throws java.sql.SQLException, java.rmi.RemoteException, DataException
java.sql.SQLException
java.rmi.RemoteException
DataException
int update(Instance i) throws java.sql.SQLException, java.rmi.RemoteException, DataException
java.sql.SQLException
java.rmi.RemoteException
DataException
Instance getInstance(java.lang.String classname, long oid) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
Instance getInstance(java.lang.String classname, java.lang.String propertyname, java.lang.String value) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
Instance getInstance(long classid, long oid) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
Instance getInstance(long classid, java.lang.String propertyname, java.lang.String value) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet getInstanceSet(long classid, java.lang.String propertyname, java.lang.String value) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet getInstanceSet(java.lang.String classname, java.lang.String propertyname, java.lang.String value) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet getInstanceSetValidStatus(java.lang.String classname, java.lang.String filter, java.lang.String value, boolean bValidStatus) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet getInstanceSetValidStatus(java.lang.String classname, java.lang.String propertyname, int operator, java.lang.Object value, boolean bValidStatus) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet getInstances(java.lang.String string) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
DataInstanceSet executeQuery(SelectQuery q, boolean formattedValues) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
DataInstanceSet executeQuery(SelectQuery q, java.lang.Boolean formattedValues) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
java.lang.String echo(java.lang.String challenge)
DataInstanceSet executeQuery(java.lang.String classname, SelectQuery q) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
InstanceSet executeText(java.lang.String text) throws java.sql.SQLException, java.rmi.RemoteException
text
- is the sql command
java.sql.SQLException
java.rmi.RemoteException
void executeTextNoReturn(java.lang.String text) throws java.sql.SQLException, java.rmi.RemoteException
text
- is the sql command
java.sql.SQLException
java.rmi.RemoteException
long getPrimaryKeys(java.lang.String type, java.lang.String classname, java.lang.Integer num) throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
RelationVO getRelation(ClassVO c, PropertyVO p)
RelationVO getRelation(java.lang.String relname)
ListType getListById(long listId) throws ListNotFoundException
ListNotFoundException
ListVO getListByName(java.lang.String listName) throws ListNotFoundException
ListNotFoundException
ListVO[] getLists()
boolean saveList(ListVO list) throws java.rmi.RemoteException, java.sql.SQLException, DataException, QuerySaveException
java.rmi.RemoteException
java.sql.SQLException
DataException
QuerySaveException
java.lang.String getConfigItemValue(java.lang.String configSet, java.lang.String configItem) throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
java.lang.String getConfigItemValue(java.lang.String configSet, java.lang.String configItem, java.lang.String defaultValue) throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
InstanceSet getConfigItems(java.lang.String configSet, java.lang.String configItem) throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
DescriptionVO getDescriptionVO(long descId) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO getDescriptionVO(java.lang.Long descId) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO getDescriptionVOFromDB(long descId, java.lang.String lang) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
DescriptionVO getDescriptionVOFromDB(java.lang.Long descId, java.lang.String lang) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
DescriptionVO getDescriptionVO(java.lang.String domain, java.lang.String name) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO getDescriptionVOFromDB(java.lang.String domain, java.lang.String name, java.lang.String lang) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
java.lang.Long createDescriptionId() throws java.sql.SQLException, java.rmi.RemoteException
java.sql.SQLException
java.rmi.RemoteException
DescriptionVO createDescriptionVO(java.lang.String domain, java.lang.String name) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO createDescriptionVO(java.lang.String domain, java.lang.String name, java.lang.String description) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO createDescriptionVO(java.lang.String domain, java.lang.String name, java.lang.String description, java.lang.String shortDescription, java.lang.String comments) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO createDescriptionVO(java.lang.String lang, long descId, java.lang.String domain, java.lang.String name, java.lang.String description, java.lang.String shortDescription, java.lang.String comments) throws java.rmi.RemoteException
java.rmi.RemoteException
DescriptionVO updateDescriptionVO(DescriptionVO descvo, java.lang.String domain, java.lang.String name, java.lang.String description, java.lang.String shortDescription, java.lang.String comments) throws java.rmi.RemoteException
java.rmi.RemoteException
void setDescription(ClassVO clsvo, DescriptionVO descvo) throws java.rmi.RemoteException, java.sql.SQLException, DataException
java.rmi.RemoteException
java.sql.SQLException
DataException
void setDescription(PropertyVO propvo, DescriptionVO descvo) throws java.rmi.RemoteException, java.sql.SQLException, DataException
java.rmi.RemoteException
java.sql.SQLException
DataException
void setDescription(RelationVO propvo, DescriptionVO descvo) throws java.rmi.RemoteException, java.sql.SQLException, DataException
java.rmi.RemoteException
java.sql.SQLException
DataException
int updateModelVersion() throws java.sql.SQLException, QueryTreeException, QuerySaveException, java.rmi.RemoteException, DataModelException, ConnectionException
java.sql.SQLException
QueryTreeException
QuerySaveException
java.rmi.RemoteException
DataModelException
ConnectionException
void saveAppVO() throws DataModelException, java.rmi.RemoteException, SchemaUpdateException
DataModelException
java.rmi.RemoteException
SchemaUpdateException
void saveAppVO(AppVO newAppVO) throws DataModelException, java.rmi.RemoteException, SchemaUpdateException
DataModelException
java.rmi.RemoteException
SchemaUpdateException
int saveFile(java.lang.String filename, java.lang.String scontent, ClassVO classvo, Instance instance) throws QuerySaveException, java.sql.SQLException, java.rmi.RemoteException, java.io.IOException, DataException
QuerySaveException
java.sql.SQLException
java.rmi.RemoteException
java.io.IOException
DataException
boolean doRefresh() throws java.sql.SQLException, java.rmi.RemoteException, QueryTreeException, ConnectionException, DataModelException
java.sql.SQLException
java.rmi.RemoteException
QueryTreeException
ConnectionException
DataModelException
boolean doRefresh(java.lang.Boolean askServerRefresh) throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException, ConnectionException, DataModelException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
ConnectionException
DataModelException
boolean doRefresh(boolean askServerRefresh) throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException, ConnectionException, DataModelException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
ConnectionException
DataModelException
java.lang.String getAuthType() throws java.rmi.RemoteException, java.sql.SQLException, QueryTreeException
java.rmi.RemoteException
java.sql.SQLException
QueryTreeException
CLBrowser.AuthState authenticate(java.lang.String user, java.lang.String pass) throws AuthenticationException, java.sql.SQLException, java.rmi.RemoteException
AuthenticationException
java.sql.SQLException
java.rmi.RemoteException
boolean changePassword(java.lang.String user, java.lang.String pass, java.lang.String newpass) throws AuthenticationException, java.sql.SQLException, java.rmi.RemoteException
AuthenticationException
java.sql.SQLException
java.rmi.RemoteException
boolean resetUserPassword(java.lang.String adminuser, java.lang.String adminpass, java.lang.String user, java.lang.String newpass) throws AuthenticationException, java.sql.SQLException, java.rmi.RemoteException
AuthenticationException
java.sql.SQLException
java.rmi.RemoteException
void impersonate(java.lang.String user, java.lang.String pass) throws AuthenticationException, DataModelException, java.rmi.RemoteException, QueryTreeException, ConnectionException, java.sql.SQLException
AuthenticationException
DataModelException
java.rmi.RemoteException
QueryTreeException
ConnectionException
java.sql.SQLException
java.lang.String getBytecode(java.lang.String classname) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.Class findClass(java.lang.String classname)
RoleVO getDefaultRole()
ListVO getListByParent(ListElmVO listElmVO)
javax.swing.Icon getIcon(java.lang.String classname)
int verifyMandatory(Instance i) throws java.rmi.RemoteException, DataModelException
java.rmi.RemoteException
DataModelException
Instance newInstance(java.lang.String classname) throws DataModelException
DataModelException
java.lang.String getSchema() throws java.rmi.RemoteException
java.rmi.RemoteException
ListType getSelectedListVO(Instance inst, int col) throws ListNotFoundException
inst
- is a data instance (record from db)col
- is the column number (starting from 0)
ListNotFoundException
byte[] getResourceBytes(java.lang.String uri)
Instance getInstance(Instance instance) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
java.lang.Long getInstanceCount(java.lang.String classname, java.lang.String filter, int operator, java.lang.String value) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
InstanceSet getInstanceSet(java.lang.String classname, java.lang.String filter, int operator, java.lang.Object val) throws java.rmi.RemoteException, java.sql.SQLException
java.rmi.RemoteException
java.sql.SQLException
void setAutomaticFields(Instance instance)
boolean isEnableFilterInactiveStates()
void setEnableFilterInactiveStates(boolean enableFilterInactiveStates)
java.lang.String getSerial()
boolean unlockAccount(java.lang.String adminuser, java.lang.String adminpass, java.lang.String user) throws java.rmi.RemoteException, java.sql.SQLException, AuthenticationException
java.rmi.RemoteException
java.sql.SQLException
AuthenticationException
java.lang.Object getPerfStats()
ValidationVO validate(Instance instance)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |