Class ActionsApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.ActionsApi

public class ActionsApi
extends SubApi

The Actions tree: saved queries, folders and the other action types the UI keeps per account. Actions are the "predefined queries" panel — a saved BQL query is an action of main type QUERY3, executed with BimApi.query(UUID, java.util.Set).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActionsApi.OutputHint	Where the UI shows a query's result; sent as output_hint.
static enum	ActionsApi.SaveMode	How updateQuery(UUID, String, String, ActionsApi.SaveMode, String) stores the change.

Constructor Summary

Constructors

Constructor	Description
ActionsApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
UUID	addFolder(UUID parentUuid, String name)	Create a folder.
UUID	addQuery(UUID parentUuid, String name, String bql, ActionsApi.OutputHint outputHint, boolean favourite)	Save a BQL query as an action of main type QUERY3.
void	deleteAction(UUID uuid)	Soft-delete an action (folders included).
com.fasterxml.jackson.databind.node.ObjectNode	getAction(UUID uuid)
com.fasterxml.jackson.databind.node.ObjectNode	getActionByPath(String path)	The action at a path relative to the account root, or null when it does not exist.
com.fasterxml.jackson.databind.node.ObjectNode	getRootAction()	The account's root action (its top-level folder), with uuid, editable and full_path.
com.fasterxml.jackson.databind.node.ArrayNode	listActions(String path)	Actions under a path like "Favourites" or "Load queries/Walls", relative to the account root.
com.fasterxml.jackson.databind.node.ArrayNode	listActions(UUID folderUuid)	The children of an action folder.
void	undeleteAction(UUID uuid)
com.fasterxml.jackson.databind.node.ObjectNode	updateQuery(UUID uuid, String name, String bql, ActionsApi.SaveMode saveMode, String comment)	Update a saved query's name and/or BQL; NEW_VERSION keeps the history.

Methods inherited from class SubApi

getBimWorksClient

Modifier and Type	Method	Description
BimWorksClient	getBimWorksClient()

Methods inherited from class Object

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

Constructor Details

ActionsApi

public ActionsApi(BimWorksClient bimWorksClient)

Method Details

getRootAction

public com.fasterxml.jackson.databind.node.ObjectNode getRootAction()
                                                             throws BimWorksException

The account's root action (its top-level folder), with uuid, editable and full_path.

Throws:

BimWorksException

listActions

public com.fasterxml.jackson.databind.node.ArrayNode listActions(UUID folderUuid)
                                                          throws BimWorksException

The children of an action folder.

Throws:

BimWorksException

listActions

public com.fasterxml.jackson.databind.node.ArrayNode listActions(String path)
                                                          throws BimWorksException

Actions under a path like "Favourites" or "Load queries/Walls", relative to the account root.

Throws:

BimWorksException

addFolder

public UUID addFolder(UUID parentUuid,
 String name)
               throws BimWorksException

Create a folder. @return the new action's uuid

Throws:

BimWorksException

addQuery

public UUID addQuery(UUID parentUuid,
 String name,
 String bql,
 ActionsApi.OutputHint outputHint,
 boolean favourite)
              throws BimWorksException

Save a BQL query as an action of main type QUERY3. @return the new action's uuid

Throws:

BimWorksException

updateQuery

public com.fasterxml.jackson.databind.node.ObjectNode updateQuery(UUID uuid,
 String name,
 String bql,
 ActionsApi.SaveMode saveMode,
 String comment)
                                                           throws BimWorksException

Update a saved query's name and/or BQL; NEW_VERSION keeps the history.

Throws:

BimWorksException

getAction

public com.fasterxml.jackson.databind.node.ObjectNode getAction(UUID uuid)
                                                         throws BimWorksException

Throws:

BimWorksException

getActionByPath

public com.fasterxml.jackson.databind.node.ObjectNode getActionByPath(String path)
                                                               throws BimWorksException

The action at a path relative to the account root, or null when it does not exist.

Throws:

BimWorksException

deleteAction

public void deleteAction(UUID uuid)
                  throws BimWorksException

Soft-delete an action (folders included).

Throws:

BimWorksException

undeleteAction

public void undeleteAction(UUID uuid)
                    throws BimWorksException

Throws:

BimWorksException