|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEngineService
Interface for communication with server
Method Summary | |
---|---|
java.lang.Boolean |
authenticate(java.lang.String login,
java.lang.String password,
boolean remember)
This method authenticates the user. |
boolean |
checkExistance(XPath path)
This methods checks existance of objects, specified via path. |
boolean |
checkExistance(XPath contextPath,
java.lang.String elementName)
More specified version of checkExistance(XPath) : it checks existance by name in some context. |
void |
forceReload()
forces reload of all connection pools, e.g. |
IClientProperties |
getClientProperties()
Retuns client properties from server. |
XElement[] |
getParentsOf(XPath contextPath,
java.lang.String elementName)
This method returns parents elements in element hierarchy for particular element. |
java.lang.Boolean |
isAuthenticated()
Checks if user is already authenticated. |
XObject |
loadChild(XPath path,
java.lang.String childId,
int type)
This methods loads single child specified by path to parend, id and type |
XObject |
loadChildByName(XPath path,
java.lang.String name,
int type)
|
XObject[] |
loadChildren(XPath path,
int type)
This method loads all children (XObjects) of type of object specified by path. |
XDefaultView |
loadDefaultView(XPath path)
This method constructs "default view", i.e. |
XFolder |
loadFavoriteViews()
Loads favorite views from server. |
void |
logoff()
Log off from the server. |
XResult[] |
query(XQueryPath[] paths)
This method returns data for cube, specified by query. |
java.lang.String |
saveView(XViewPath viewPath)
This method updates view if the one already exists and adds view otherwise. |
void |
updateData(XPath cubePath,
IXPoint point,
IResultElement value)
This method sets value of some cell of cube pointed by point |
Method Detail |
---|
java.lang.Boolean isAuthenticated()
If authentication succeed cookies max age setted up to 1 month.
java.lang.Boolean authenticate(java.lang.String login, java.lang.String password, boolean remember) throws InternalErrorException
login
- - user login. Can't be null.password
- - user password. Can't be null.remember
- - remember user and password hash in cookies.
AuthenticationError
- if something fatal-like occurred.
InternalErrorException
void logoff()
#authenticate()
will return TRUE.
XElement[] getParentsOf(XPath contextPath, java.lang.String elementName) throws InvalidObjectPathException
contextPath
- defines context of element hierarcy. Can point only to dimension or subset. Can't be null.elementName
- element name. Can't be null.
InvalidObjectPathException
- if
1. contextPath is invalid;
2. contextPath doesn't point to dimension or subset.
3. element with elementName can't be found.XDefaultView loadDefaultView(XPath path) throws InvalidObjectPathException
path
- points to cube. Can't be null.
InvalidObjectPathException
- if path it invalid or it doen't point to cube.XObject[] loadChildren(XPath path, int type) throws InvalidObjectPathException
path
- for object. Can't be null.type
- specifies chilren type. IXConsts
. If object has only one chilren type, type param have to be ingnored.
InvalidObjectPathException
- will be thrown if path is wrong
if type is wrong program behavior is unpredicted (e.g. runtime exception will be thrown)boolean checkExistance(XPath path)
path
- for object. Can't be null.
boolean checkExistance(XPath contextPath, java.lang.String elementName) throws InvalidObjectPathException
checkExistance(XPath)
: it checks existance by name in some context.
contextPath
- context path (currently: dimension/subset)elementName
- element name
InvalidObjectPathException
- if contextPath is invalid or not points to dimension/subsetXResult[] query(XQueryPath[] paths) throws InvalidObjectPathException
Assumption: all paths points to one server. Otherwise behavior is unpredicted (runtime exception will be thrown).
paths
- - array of requests XQueryPath
. It can't be null.
InvalidObjectPathException
- is thrown if one of paths doesn't points to cube or is invalid.void updateData(XPath cubePath, IXPoint point, IResultElement value) throws InvalidObjectPathException
cubePath
- points to target cubepoint
- contains coordinates of point. @{link IXPoint}value
- of the point.
InvalidObjectPathException
- if cubePath is not valid path.java.lang.String saveView(XViewPath viewPath) throws InvalidObjectPathException
viewPath
- defines the view. @{link XViewPath}.
InvalidObjectPathException
- one of paths in viewPath is invalid.void forceReload()
IClientProperties getClientProperties()
XFolder loadFavoriteViews()
XObject loadChild(XPath path, java.lang.String childId, int type) throws InvalidObjectPathException
path
- poinst to parent object.childId
- child identificatortype
- child type.
InvalidObjectPathException
- if path is invalid.XObject loadChildByName(XPath path, java.lang.String name, int type) throws InvalidObjectPathException
InvalidObjectPathException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |