http://www.awareim.com/dokuwiki/ 2026-04-23T17:53:40+00:00 http://www.awareim.com/dokuwiki/ http://www.awareim.com/dokuwiki/_media/logo.png text/html 2023-05-03T01:49:38+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/0000_start?rev=1683078578&do=diff programmers_reference methods index Programmer's Reference Methods text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/0521_get_database_interface?rev=1749700855&do=diff index programmers_reference methods isqlbuilderhelper_interface getdatabaseinterface getDatabaseInterface () public IDatabaseClientInterface getDatabaseInterface () This method returns the specific database currently used by AwareIM (see JavaDoc API for details). Parameters None Returns The database interface. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/addnotification?rev=1749700855&do=diff index programmers_reference methods messagebuilder_class addnotification addNotification (EntityIdentifier, INotification) public DataObject [] addNotification (EntityIdentifier receiver, INotification notification) This method constructs a message representing a notification Parameters receiverthis should always be null text/html 2023-05-08T06:29:06+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/addreferences?rev=1683527346&do=diff index programmers_reference methods iexecutionengine_interface addreferences addReferences (IProcess, String, Long, String, EntityIdAndName []) public void addReferences(IProcessparent, String refOwnerName, Long refOwnerId, String refOwnerAttr, EntityIdAndName [] refsToAdd) throws ServerTimeOutException, AccessDeniedException,ExecutionException; text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/addservicerequest?rev=1749700855&do=diff index programmers_reference methods messagebuilder_class addservicerequest addServiceRequest (String, String, Object []) public DataObject [] addServiceRequest (String componentName, String serviceName, Object [] parameters) This method constructs a message representing a service request Parameters componentNamethis should always be text/html 2023-05-08T06:29:47+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/aftercolumninit?rev=1683527387&do=diff index programmers_reference methods ireport_environment afterreportinit afterColumnInit (IReportEnvironment) public** void afterColumnInit (IReportEnvironment environment) throws Exception This method is called after the initialization of each column. text/html 2023-05-08T06:30:05+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/afterdetaileval?rev=1683527405&do=diff index programmers_reference methods ireport_environment afterdetaileval afterDetailEval (IReportEnvironment) public** void afterDetailEval (IReportEnvironment environment) throws Exception This method is called after evaluation of the details section of the report. text/html 2023-05-08T06:30:24+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/aftergroupinit?rev=1683527424&do=diff index programmers_reference methods ireport_environment afterreportinit afterGroupInit (String, IReportEnvironment) public void afterGroupInit (String groupName, IReportEnvironment environment) throws Exception This method is called after the specified group has been initialized. text/html 2023-05-08T06:30:41+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/afterpageinit?rev=1683527441&do=diff index programmers_reference methods ireport_environment afterpageinit afterPageInit (IReportEnvironment) public void afterPageInit (IReportEnvironment environment) throws Exception This method is called after the initialization of each page. text/html 2023-05-08T06:30:59+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/afterreportinit?rev=1683527459&do=diff index programmers_reference methods ireport_environment afterreportinit afterReportInit (IReportEnvironment) public void afterReportInit (IReportEnvironment environment) throws Exception This method is called immediately after the report has been initialized. text/html 2023-05-08T06:40:43+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/beforecolumninit?rev=1683528043&do=diff index programmers_reference methods ireport_environment beforecolumninit beforeColumnInit (IReportEnvironment) public void beforeColumnInit (IReportEnvironment environment) throws Exception This method is called before each column is initialized. text/html 2023-05-08T06:41:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/beforedetaileval?rev=1683528064&do=diff index programmers_reference methods ireport_environment beforedetaileval beforeDetailEval (IReportEnvironment) public void beforeDetailEval (IReportEnvironment environment) throws Exception This method is called before evaluation of the details section of the report. text/html 2023-05-08T06:41:24+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/beforegroupinit?rev=1683528084&do=diff index programmers_reference methods ireport_environment beforegroupinit beforeGroupInit (String, IReportEnvironment) public void beforeGroupInit (String groupName, IReportEnvironment environment) throws Exception This method is called just before the specified group is initialized. text/html 2023-05-08T06:41:49+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/beforepageinit?rev=1683528109&do=diff index programmers_reference methods ireport_environment beforepageinit beforePageInit (IReportEnvironment) public void beforePageInit (IReportEnvironment environment) throws Exception This method is called just before each page is initialized. text/html 2023-05-08T06:42:06+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/beforereportinit?rev=1683528126&do=diff index programmers_reference methods ireport_environment beforereportinit beforeReportInit (IReportEnvironment) public** void beforeReportInit (IReportEnvironment environment) throws Exception This method is called just before the report is initialized. text/html 2023-05-08T06:47:34+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/calculate?rev=1683528454&do=diff index programmers_reference methods ifunctionlibrary_interface calculate calculate (String, Object [], INodeHelper) public Object calculate (String functionName, Object [] parameters, INodeHelper helper) This method is what the function is all about – it performs the required calculation and returns the result. Parameters text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/cancel?rev=1749700855&do=diff index programmers_reference methods iprocess iprocess_methods cancel cancel () public boolean cancel (); This method is called by the AwareIM framework when the operator sends the request to cancel the process. Parameters none Returns The method should return true if it allows the system to cancel the process. In this case it should set an internal flag indicating that the process has been cancelled. The execute and resume methods should periodically check this flag and if its value is tr… text/html 2023-05-08T06:47:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/canhaveexternalresources?rev=1683528472&do=diff index programmers_reference methods idocengineclient_interface canhaveexternalresources canHaveExternalResources () public boolean canHaveExternalResources () This method must return true if documents of the new type can have resources that are stored outside of the document file itself – for example, HTML documents can have image files stored separately whereas MS Word documents are self-contained. text/html 2023-05-08T06:48:32+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/createdynamictemplate?rev=1683528512&do=diff index programmers_reference methods idocengineclient_interface createdynanictemplate createDynamicTemplate (String, String, byte [], String) public DataPresentationTemplate createDynamicTemplate (String templateName, String fileName, byte [] fileData, String dirPath) Implementers of this method are supposed to create the DataPresentationTemplate on the fly from the given parameters. They should also save the template file and all resources (if any) in the provided directory. text/html 2023-05-08T06:49:02+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/createentity?rev=1683528542&do=diff index programmers_reference methods iexecutionengine_interface createentity createEntity (IProcess, String) public IEntitycreate Entity(IProcessparent, StringentityName) throws ServerTimeOutException, AccessDeniedException, ExecutionException; This method creates new instance of the specified business object. If there are any rules associated with the business object they are executed. text/html 2023-05-08T06:49:23+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/createentityfromtemplate?rev=1683528563&do=diff index programmers_reference methods iexecutionengine_interface createentityfromtemplate createEntityFromTemplate (IProcess, IEntityTemplate, ChangedReference []) public IEntitycreateEntityFromTemplate ( IProcessparent, IEntityTemplate template, ChangedReference [] changedRefs) throws ServerTimeOutException, AccessDeniedException, ExecutionException; text/html 2023-05-08T06:49:50+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/createnotification?rev=1683528590&do=diff index programmers_reference methods iexecutionengine_interface createnotification createNotification (IProcess, String) public INotification createNotification (IProcessparent, String notificationName) throws ServerTimeOutException, AccessDeniedException, ExecutionException; This method creates the specified notification. If there are any rules associated with the creation of the notification they are executed. text/html 2023-05-08T06:50:20+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/deepcopy?rev=1683528620&do=diff index programmers_reference methods ientity_interface deepcopy deepCopy () / IEntity public IObject deepCopy (); This method takes a “deep” copy of “this” object. Parameters None Returns Copied business object or notification text/html 2023-05-08T06:50:39+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/deepcopy_datapresentationtemplate?rev=1683528639&do=diff index programmers_reference methods datapresentationtemplate_class deepcopy deepCopy () / DataPresentationTemplate public IConfigurationElement deepCopy () This method creates a “deep copy” of “this” Parameters none Returns copy of “this” as IConfigurationElement (which can be cast back to the DataPresentationTemplate text/html 2023-05-08T06:51:08+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/deleteentities?rev=1683528668&do=diff index programmers_reference methods iexecutionengine_interface deleteentities deleteEntities (IProcess, EntityIdAndName []) public void deleteEntities(IProcessparent, EntityIdAndName [] entities) throws ServerTimeOutException, AccessDeniedException, ExecutionException; This method deletes the specified instances of the business objects. If there are references to the deleted instances anywhere in the database, these references are deleted as well. If the deleted instance is a parent of some o… text/html 2023-05-08T06:51:35+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/deletereferences?rev=1683528695&do=diff index programmers_reference methods iexecutionengine_interface deletereferences deleteReferences (IProcess, String, Long, String, EntityIdAndName []) public void deleteReferences(IProcessparent, String refOwnerName, Long refOwnerId, String refOwnerAttr, EntityIdAndName [] refsToDelete) throws ServerTimeOutException, AccessDeniedException,ExecutionException; text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/elementsrenamed?rev=1749700855&do=diff index programmers_reference methods idocengineclient_interface elementsrenamed elementsRenamed (DataPresentationTemplate, RenamedElements, INodeChangeHelper, IDomainVersion) public DataPresentationTemplate elementsRenamed (DataPresentationTemplate oldTemplate, RenamedElements renamedElements, InodeChangeHelper helper, IDomainVersion domainVersion) text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/execute?rev=1749700855&do=diff index programmers_reference methods iprocess iprocess_methods execute execute (IExecutionEngine, Object []) public Object execute (IExecutionEngine engine, Object[]parameters) throws SuspendProcessException, ExecutionException, AccessDeniedException; This is the main method of the interface that is called when the process is started. text/html 2023-05-08T06:52:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/executechildprocess?rev=1683528772&do=diff index programmers_reference methods iexecutionengine_interface executechildprocess executeChildProcess (IProcess, String, IEntity [], Boolean) public IProcess executeChildProcess (IProcessparent, String processName, IEntity [] parameters, Boolean asynchronous) throws ServerTimeOutException, AccessDeniedException, ExecutionException; text/html 2023-05-08T06:53:17+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/executeentityservice?rev=1683528797&do=diff index programmers_reference methods iexecutionengine_interface executeentityservice index executeEntityService (IProcess, String, EntityIdentifier, IEntity [], String, Boolean) public INotification executeEntityService (IProcessparent, String serviceName, EntityIdentifier provider, IEntity [] parameters, String channelTypeName, Boolean asynchronous) throws ServerTimeOutException, AccessDeniedException, ExecutionException; text/html 2023-05-08T06:53:50+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/executenamedquery?rev=1683528830&do=diff index programmers_reference methods iexecutionengine_interface executenamedquery executeNamedQuery (IProcess, String, Integer, Integer) public QueryResult executeNamedQuery (IProcessparent, String queryName, Integer startRange, Integer span) throws AccessDeniedException, ExecutionException; This method runs the query with the specified name and returns the instances of the business objects matching the conditions of the query. The query with this name must be configured in the business space … text/html 2023-05-08T06:54:10+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/executequery?rev=1683528850&do=diff index programmers_reference methods iexecutionengine_interface executequery executeQuery (IProcess, Query, Integer, Integer) public QueryResult executeQuery (IProcessparent, Query query, Integer startRange, Integer span) throws AccessDeniedException, ExecutionException; This method is very similar to the executeNamedQuery method except that it runs the provided query instead of the configured query. The provided query does not have to exist in the business space version and may be created by … text/html 2023-05-08T06:54:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/exportentities?rev=1683528870&do=diff index programmers_reference methods iexecutionengine_interface exportentities exportEntities (IProcess, IEntity [], String, ExportOptions) public void exportEntities (IProcessparent, IEntity [] entsToExport, String exportFileName, ExportOptions options) throws AccessDeniedException, ExecutionException; This method exports the specified instances of the specified business object into the specified file (see also text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/fillwithdata?rev=1749700855&do=diff index programmers_reference methods idocumentengine_interface fillwithdata fillWithData (String, Map, IDocumentDataSource, DataPresentationTemplate, IDocEngineHelper, IDomainVersion, int, Boolean, int) public ReportResult fillWithData ( String dirPath, Map params, IDocumentDataSource dataSource, DataPresentationTemplate template, IDocEngineHelper helper, IDomainVersion domainVersion, int outputFormat, boolean printResults, int numCopies) throws DocumentExcep… text/html 2023-05-08T06:55:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getaccesslevel?rev=1683528931&do=diff index programmers_reference methods iexecutioncontext_interface getaccesslevel getAccessLevel () public AccessLevel getAccessLevel () Parameters None Returns The access level of the user that started the process. text/html 2023-05-08T06:55:48+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getallreferences?rev=1683528948&do=diff index programmers_reference methods iexecutionengine_interface getallreferences getAllReferences (IProcess, IEntity, String) public IEntity [] getAllReferences(IProcessparent, IEntity refOwner, String refOwnerAttr) throws AccessDeniedException, ExecutionException; This method retrieves all references of the specified instance of the business object referenced by the specified attribute of the reference type. The method text/html 2023-05-08T06:56:17+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getattributepaths?rev=1683528977&do=diff index programmers_reference methods datapresentationtemplate_class getattributepaths getAttributePaths () public String [] getAttributePaths () This method returns the attribute paths used inside tags in the document template. The attribute paths are represented in the form objectName.attributeName. Note that the paths returned are not necessarily the complete expressions used inside the tags. A tag expression may contain not only the attribute paths, but also arithmetic expressions with thes… text/html 2023-05-08T06:56:36+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getattributevalue?rev=1683528996&do=diff index programmers_reference methods ientity_interface getattributevalue getAttributeValue (String) public Object getAttributeValue (String attributeName) throws InvalidParameterException This method returns the value of the specified attribute. Note: the attribute must not be a reference. Use the getReferences method to retrieve references. text/html 2026-02-04T01:36:32+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getavailablefunctions?rev=1770168992&do=diff index programmers_reference methods ifunctionlibrary_interface getavailablefunctions getAvailableFunctions () public FunctionDescription [] getAvailableFunctions () This method must return all functions supported by the library as an array of structures containing the function name and the short description of what the function does. text/html 2023-05-03T04:19:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getbinarydata?rev=1683087571&do=diff programmers_reference methods iexecutionengine_interface getbinarydata index getBinaryData (IProcess, String, Long, String) public byte [] getBinaryData (IProcessparent,StringentityName, Long id, String attributeName) throws AccessDeniedException, ExecutionException; This method retrieves the value of the specified binary attribute of the specified instance of the business object. Normally if an instance of a business object is retrieved using text/html 2023-05-03T04:20:05+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getchannelsettingseditor?rev=1683087605&do=diff programmers_reference methods ichanneltype_interface getchannelsettingseditor index getChannelSettingsEditor () public String getChannelSettingsEditor () This method must return the fully qualified name of the component that will provide the user interface to edit the channel-specific properties (see also Implementing Channel Settings Editor). If there are no channel-specific properties that need to be specified by the user, text/html 2023-05-03T04:21:24+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getchannelvalues?rev=1683087684&do=diff programmers_reference methods messageinterpreter_class getchannelvalues index getChannelValues () public DataObject getChannelValues () Retrieve the data object containing values specific to the receiver of the message.It may happen that the same channel is used to send messages to different intelligent business objects (for example, an e-mail channel may be used to send e-mails to different recipients). If this is the case the message itself must contain the values, which uniquely identify t… text/html 2023-05-03T04:21:34+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getclientengine?rev=1683087694&do=diff programmers_reference methods idocumentengine_interface getclientengine index getClientEngine () public IDocEngineClient getClientEngine () This method must return the component that implements the document type on the client side – see Implementing Client Side Component Parameters none Returns the instance of the client side component (must not be null text/html 2023-05-03T04:22:43+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getdefaultchannelsettings?rev=1683087763&do=diff programmers_reference methods ichanneltype_interface getdefaultchannelsettings index getDefaultChannelSettings () public Properties getDefaultChannelSettings () This method must return the properties that will be used by default for business objects communicating through the channel. The non-null value should generally be returned if there are settings for the channel that are editable by the user in the Configuration Tool. The returned values will be used to initialize the channel settings … text/html 2023-05-03T04:22:59+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getdomainversion?rev=1683087779&do=diff programmers_reference methods iexecutioncontext_interface getdomainversion index getDomainVersion () public IDomainVersion getDomainVersion () Parameters None Returns The current business space version. text/html 2023-05-03T04:23:08+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/geteditcommand?rev=1683087788&do=diff programmers_reference methods idocengineclient_interface geteditcommand index getEditCommand () public FileToEdit getEditCommand (String filePath) This method must return the operating system specific command that should be invoked to edit a document template of the new type. This command is invoked when the user presses the Edit button in the Document Template Property Editor of the Configuration Tool. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getelementvalue?rev=1749700855&do=diff programmers_reference methods report_scriptlets ireportenvironment_interface getelementvalue index getElementValue (String) public Object getElementValue (String elementName) throws Exception This method returns the current value of the report element with the specified name. The element must be either an element with a scriptlet attached (text or image) or a tag element, in which case the current value of the tag expression is retrieved. Each element in the report may be given a name in its… text/html 2023-05-03T04:23:32+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getentities?rev=1683087812&do=diff programmers_reference methods iexecutionengine_interface getentities index getEntities (IProcess, EntityIdAndName []) public IEntity [] getEntities(IProcessparent, EntityIdAndName [] entities) throws AccessDeniedException, ExecutionException; This method retrieves the specified instances of the specified business objects. text/html 2023-05-03T04:23:44+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getentity?rev=1683087824&do=diff programmers_reference methods iexecutionengine_interface getentity index getEntity (IProcess, String, Long) public IEntity getEntity(IProcessparent, StringentityName, Long id) throws AccessDeniedException,ExecutionException; This method retrieves the specified instance of the specified business object. Any large binary attributes (of the Binary, Document and Picture types) are not retrieved by this method – the value of the corresponding attributes will be null. To retrieve the values of the… text/html 2023-05-03T04:23:53+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getexecutioncontext?rev=1683087833&do=diff programmers_reference methods iexecutionengine_interface getexecutioncontext index getExecutionContext (IProcess) public IExecutionContext getExecutionContext (IProcess process) This method provides the execution context in which the process is running. Parameters processthe process whose execution context is required Returns The execution context in which the process is running as an instance of the text/html 2023-05-03T04:24:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getexpressionvalue?rev=1683087844&do=diff programmers_reference methods idocumentdatasource_interface getexpressionvalue index getExpressionValue (String) public Object getExpressionValue (String expression) throws Exception This method calculates the value of an expression inside a tag. The expression may be a reference to the object's attribute (attribute path) or a more complicated arithmetic expression. If the expression contains the formatting expression, the result is converted to the specified format; otherwise it is converte… text/html 2023-05-03T04:29:23+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getexpressionvalueforcalcs?rev=1683088163&do=diff programmers_reference methods idocumentdatasource_interface getexpressionvalueforcalcs index getExpressionValueForCalcs (String) public Object getExpressionValueForCalcs (String expression) throws Exception This method is very similar to the getExpressionValue method. The only difference is that the resulting value is not converted into any presentation format. text/html 2023-05-03T04:29:33+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getexternalname?rev=1683088173&do=diff programmers_reference methods ichanneltype_interface getexternalname index getExternalName () public String getExternalName () This method must return the name by which the channel will be known to configurators. This name is displayed in the list of available channels of the intelligent business object. This name is not used by the system in any other way. text/html 2023-05-03T04:29:49+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getframepanelid?rev=1683088189&do=diff programmers_reference methods awareapp_object getframepanelid index getFramePanelId (frameName) var id = AwareApp.getFramePanelId (main); This method returns the unique id of the frame in a visual perspective. Parameters frameNamename of the frame in the visual perspective text/html 2023-05-03T04:31:10+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getid?rev=1683088270&do=diff programmers_reference methods ientity_interface getid index getId () public long getId () Parameters None Returns The unique id of the business object instance (always –1 for notifications). The unique id is automatically assigned to the business object instance by the system when the instance is created. text/html 2023-05-03T04:31:20+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getinputsourceclassname?rev=1683088280&do=diff programmers_reference methods ichanneltype_interface getinputsourceclassname index getInputSourceClassName () public String getInputSourceClassName () This method must return the fully qualified name of the Source that handles communication with the external software system or device (see also Implementing Channel’s Source and Sink). If messages from the external system or device are never received (only sent to), text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getintelligencetypeapplicability?rev=1749700855&do=diff programmers_reference methods ichanneltype_interface getintelligencetypeapplicability index getIntelligenceTypeApplicability () public int [] getIntelligenceTypeApplicability () This method must return those types of intelligent business object that the channel is applicable for. For example, the SOAP or Sockets channel is not applicable to business objects with the Human intelligence and the E-mail channel is not applicable to Devices. The constants specifying possible intelligence types ar… text/html 2023-05-03T04:31:43+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getloadedresources?rev=1683088303&do=diff programmers_reference methods getloadedresources index getLoadedResources () public BinaryResource [] getLoadedResources () This method retrieves any resources that the document may have that are stored outside of the document template file (for example, images, fonts etc). Parameters none Returns text/html 2023-04-04T07:38:45+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getloadedtemplate?rev=1680593925&do=diff programmers_reference methods datapresentationtemplate_class datapresentationtemplate_class_methods getloadedtemplate getLoadedTemplate () public BinaryResource getLoadedTemplate () This method returns the data for the document template as a BinaryResource. BinaryResource is a structure that contains the document file name and the binary data of the document as an array of bytes. This method should be used by text/html 2023-05-03T04:31:51+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getloginname?rev=1683088311&do=diff programmers_reference methods iexecutioncontext_interface getloginname index getLoginName () public String getLoginName () Parameters None Returns The login name of the user that started the process. text/html 2023-05-03T04:32:17+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getmaintabpanel?rev=1683088337&do=diff programmers_reference methods awareapp_object getmaintabpanel index getMainTabPanel () If a visual perspective has tabs return the tab panel holding the tabs. text/html 2023-05-03T04:32:27+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getmessage?rev=1683088347&do=diff programmers_reference methods inotification_interface getmessage index getMessage () public String getMessage () Parameters None Returns Any message associated with the notification (for example, the error message if the service request failed) or null if no message is associated with the notification. text/html 2023-05-03T04:32:37+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getmessagevalue?rev=1683088357&do=diff programmers_reference methods ichanneltype_interface getmessagevalues index getMessageValues () public DataObject getMessageValues (IchannelTypeCallback callback) This method is called when a notification is sent to an intelligent business object. The method is supposed to return the values that are specific to the communication with this particular instance of the object – for example, an e-mail address of this instance. The method can use a callback interface to get the instance of the obj… text/html 2023-05-03T04:32:57+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getname?rev=1683088377&do=diff programmers_reference methods ientity_interface getname index getName () / IEntity public String getName () Parameters None Returns The name of the business object or notification as configured in the business space version. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getname_ichannel?rev=1749700855&do=diff programmers_reference methods ichanneltype_interface getname index getName () / IChannel public String getName () This method must return the unique name of the channel within the AwareIM system. This is the name that can be used by the executeEntityService and sendNotification methods of the IExecutionEngine interface and the REQUEST SERVICE and SEND actions of the Rule Language. This name is for system purposes only – it is not displayed in the list of available channels of the intelligent… text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getname_ifunction?rev=1749700855&do=diff programmers_reference methods ifunctionlibrary_interface getname index getName () / IFunctionLibrary public String getName () This method must return the name of the library. The name must be unique within the AwareIM system. Parameters None Returns The name of the library. text/html 2023-05-03T04:33:28+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getnotification?rev=1683088408&do=diff programmers_reference methods messageinterpreter_class getnotifcation index getNotification () public INotification getNotification () Retrieve the notification from the message. Parameters none Returns The notification contained in the message or null if the message represents a service request. text/html 2023-05-03T04:33:38+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getobjectreferences?rev=1683088418&do=diff programmers_reference methods iexecutionengine_interface getobjectreferences index getObjectReferences (IProcess, IEntity, String) public Vector getObjectReferences (IProcessparent, IEntity refOwner, String refOwnerAttr) throws AccessDeniedException, ExecutionException; This method is very similar to the getAllReferences method. However, it returns references as a collection of text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getoutputsinkclassname?rev=1749700855&do=diff programmers_reference methods ichanneltype_interface getoutputsinkclassname index getOutputSinkClassName () public String getOutputSinkClassName () This method must return the fully qualified name of the Sink that handles communication with the external software system or device (see also Implementing Channel’s Source and Sink). If messages are never sent from AwareIM text/html 2023-05-10T01:40:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getpanelid?rev=1683682852&do=diff programmers_reference methods awareapp_object getpanelid index +++INSTRUCTIONS+++ Update the tags ABOVE to show CLASS_OR_INTERFACE_NAME NAME_OF_THE_METHOD getPanelId (frameName, tabName, contentPanelName) var id = AwareApp.getPanelId ('main', 'Tab1', 'Content Panel1'); This method returns the unique id of the content panel in a visual perspective. text/html 2023-05-03T04:35:12+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getprocessid?rev=1683088512&do=diff programmers_reference methods awareapp_object getprocessid index getProcessId () Return the id of the currently running process or -1 if there are no processes currently running. text/html 2023-05-03T04:35:21+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getprogress?rev=1683088521&do=diff programmers_reference methods iexecutioncontext_interface getprogress index getProgress () public int getProgress () Parameters none Returns The number identifying the current progress of the process in percents. text/html 2023-05-03T04:35:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getreferences?rev=1683088531&do=diff programmers_reference methods ientity_interface getreferences index getReferences (String) public ObjectReference [] getReferences (String attributeName) throws InvalidParameterException This method retrieves references of the business object or notification. If the business object was obtained in the first place by the calls to the text/html 2023-05-03T04:35:44+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getrequiredfactpatterns?rev=1683088544&do=diff programmers_reference methods ifunctionlibrary_interface getrequiredfactpatterns index getRequiredFactPatterns (String, Collection) public HashSet getRequiredFactPatterns (String functionName, Collection parameters) Parameters functionNamethe name of the function in the library the return type of which is required.parametersthe parameters of the function specified as a collection of the text/html 2023-05-03T04:35:59+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getservicename?rev=1683088559&do=diff programmers_reference methods messageinterpreter_class getservicename index getServiceName () public String getServiceName () Retrieve the name of the requested service from the message. Parameters none Returns the service name of the requested service or null if the message represents a notification. text/html 2023-05-03T04:36:09+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getserviceparameters?rev=1683088569&do=diff programmers_reference methods messageinterpreter_class getserviceparameters index getServiceParameters () public Collection getServiceParameters () Retrieve parameters of the requested service from the message. Parameters none Returns Parameters of the requested service as a collection of IEntity objects or null if the message represents a notification or if the service requires no parameters. text/html 2023-05-03T04:36:20+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getservicestatus?rev=1683088580&do=diff programmers_reference methods inotification_interface getservicestatus index getServiceStatus () public int getServiceStatus () This method returns the status of service request. Valid values are: SERVICE_STATUS_SUCCESS; SERVICE_STATUS_WAITING; SERVICE_STATUS_FAILURE; Parameters None Returns An integer indicating the service status. text/html 2023-05-03T04:36:40+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getsinksettings?rev=1683088600&do=diff programmers_reference methods ichanneltype_interface getsinksettings index getSinkSettings () public Properties getSinkSettings (Properties channelSettings) This method extracts the channel settings specific only to the Sink supported by the channel from the combined settings that has properties of both Sink and Source. This may only be relevant if for whatever reason the Sink cannot use the combined channel settings. text/html 2023-05-03T04:36:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getsourcesettings?rev=1683088612&do=diff programmers_reference methods ichanneltype_interface getsourcesettings index getSourceSettings () public Properties getSourceSettings (Properties channelSettings) This method extracts the channel settings specific only to the Source supported by the channel from the combined settings that has properties of both Sink and Source. This may only be relevant if for whatever reason the Source cannot use the combined channel settings. text/html 2023-05-03T04:37:03+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getstartuptime?rev=1683088623&do=diff programmers_reference methods iexecutioncontext_interface getstartuptime index getStartupTime () public Date getStartupTime () Parameters none Returns The date and time when the process was started as java.util.Date object. text/html 2023-05-03T04:39:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/getsuspensiontime?rev=1683088744&do=diff programmers_reference methods iexecutioncontext_interface getsuspensiontime index getSuspensionTime () public Date getSuspensionTime () Parameters None Returns The date and time when the process was last suspended as java.util.Date object or null if the process was never suspended. text/html 2023-05-03T04:39:15+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/gettabpanelid?rev=1683088755&do=diff programmers_reference methods awareapp_object gettabpanelid index getTabPanelId (frameName, tabName) var id = AwareApp.getTabPanelId ('main', 'Tab1'); This method returns the unique id of the tab in a visual perspective. Parameters frameNamename of the frame in the visual perspective that contains the paneltabName text/html 2023-05-03T04:39:25+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/gettemplatefiletype?rev=1683088765&do=diff programmers_reference methods idocengineclient_interface gettemplatefiletype index getTemplateFileType () public String getTemplateFileType () This method must return the file extension specific to the new document type (without a dot) – for example, “txt” for text documents. Parameters none Returns a string identifying the document type file extension. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/gettemplatetype?rev=1749700855&do=diff programmers_reference methods idocengineclient_interface gettemplatetype index getTemplateType () public String getTemplateType () This method must return a string that uniquely identifies the new document type in the AwareIM system. This is the string that is also displayed in the list of available document types in the Document Template Property Editor of the Configuration Tool. text/html 2023-05-03T04:39:47+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/gettimeout?rev=1683088787&do=diff programmers_reference methods iexecutioncontext_interface gettimeout index getTimeout () public long getTimeout () Parameters None Returns The number of milliseconds that the system will wait before timing out the process when it is suspended. If the value is –1 the process never times out (this is the default value). text/html 2023-05-03T04:39:58+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/gettypeclass?rev=1683088798&do=diff programmers_reference methods ifunctionlibrary_interface gettypeclass index getTypeClass (String, Collection) public Class getTypeClass (String functionName, Collection parameters) This method must return the class of the object that is returned when the function is calculated – see calculate method. Parameters functionNamethe name of the function in the library the return type of which is required text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/hasfunction?rev=1749700855&do=diff programmers_reference methods ifunctionlibrary_interface hasfunction index hasFunction (String, int) public boolean hasFunction (String functionName, int paramNmb) This method must return true if the library contains the function with the specified name and number of parameters. AwareIM will call this method to find the library responsible for the calculation of a particular function referenced in a rule. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/importdata?rev=1749700855&do=diff programmers_reference methods iexecutionengine_interface importdata index importData (IProcess, String, String, Integer, Boolean) public Collection importData (IProcessparent, String entityName, String importFileName, Integer batchSize, Boolean validate) throws AccessDeniedException, ExecutionException; This method imports the instances of the specified business object into the system from the specified file (see also text/html 2023-05-03T04:41:20+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/importrelationships?rev=1683088880&do=diff programmers_reference methods iexecutionengine_interface importrelationships index importRelationships (IProcess, String, String, Integer) public void importRelationships (IProcessparent, String entityName, String importFileName, Integer batchSize) throws AccessDeniedException, ExecutionException; This method imports the relationships of the specified business object into the system from the specified file (see also text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/initialisetemplate?rev=1749700855&do=diff programmers_reference methods idocengineclient_interface initialisetemplate index initialiseTemplate (DataPresentationTemplate, IDomainVersion) public void initialiseTemplate (DataPresentationTemplate template, IDomainVersion domainVersion) throws Exception This method is called by AwareIM when a new document template is being created in the Configuration Tool. The method is supposed to find the attribute paths referenced by tags contained in the document template and set the information abo… text/html 2023-05-09T02:30:16+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/isrtl?rev=1683599416&do=diff index programmers_reference methods awareapp_object isrtl isRTL () Return true if the current user uses right-to-left layout Returns True if current user uses RTL text/html 2023-05-09T02:30:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/isservicerequest?rev=1683599404&do=diff index programmers_reference methods messageinterpreter_class isservicerequest isServiceRequest () public boolean isServiceRequest () Parameters none Returns True if the message represents a service request or false if the message represents a notification. text/html 2023-05-09T02:29:54+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/istestingmode?rev=1683599394&do=diff index programmers_reference methods awareapp_object istestingmode isTestingMode () Return true if the current user is running in the testing mode text/html 2023-05-09T02:29:45+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/messagebuilder?rev=1683599385&do=diff index programmers_reference methods messagebuilder_class messagebuilder MessageBuilder () public MessageBuilder () Constructor. Parameters none text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/messageinterpreter?rev=1749700855&do=diff index programmers_reference methods messageinterpreter_class messageinterpreter MessageInterpreter (DataObject []) public MessageInterpreter (DataObject [] message) Constructor. Construct MessageInterpreter from the array of DataObjects representing the message sent by AwareIM to an external party. Parameters messagean array of DataObject’s sent by text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/multiuser?rev=1749700855&do=diff index programmers_reference methods ichanneltype_interface multiuser multiUser () public boolean multiUser () This method must returntrue if communication with several intelligent business objects is possible through the channel. In this case a message sent through the channel must identify the recipient of the message. For example, the E-mail channel allows communicating with several recipients (a message contains an e-mail address of the recipient) whereas a dedicated channel handling the … text/html 2023-05-09T02:28:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/next?rev=1683599332&do=diff index programmers_reference methods idocumentdatasource_interface next next () public boolean next () This method positions the data source on the next element if there is any. When called immediately after reset positions the data source on the first element. Parameters none Returns true if the method found next element to position itself on or false if there is no more data in the data source. text/html 2023-05-09T01:26:43+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/printfile?rev=1683595603&do=diff index programmers_reference methods idocumentengine_interface printfile printFile () public void printFile (File fileToPrint) throws DocumentException This method is supposed to print the specified file. It is assumed that the provided file is of the format supported by the document type (presumably obtained by calling the text/html 2023-05-09T01:26:52+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/reset?rev=1683595612&do=diff index programmers_reference methods idocumentdatasource_interface reset reset () public void reset () This method positions the data source before the start of the first element. The subsequent call to the next method will position the data source on the first element. This method must be called at the start of iterations over the elements of the data source. text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/resume?rev=1749700855&do=diff index programmers_reference methods iprocess iprocess_methods resume resume (IExecutionEngine, Object []) public Object resume(IExecutionEngine engine, Object reply) throws SuspendProcessException, ExecutionException, AccessDeniedException; This method is called by the AwareIM framework when the process receives the reply from the service provider and gets resumed. text/html 2023-05-08T06:55:10+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/sendnotification?rev=1683528910&do=diff index programmers_reference methods iexecutionengine_interface sendnotification sendNotification (IProcess, IEntity, INotification, String) public void sendNotification (IProcessparent, IEntity recipient, INotification notification, String channelTypeName) throws ServerTimeOutException, AccessDeniedException, ExecutionException; text/html 2023-05-03T04:56:25+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setattributepaths?rev=1683089785&do=diff index programmers_reference methods datapresentationtemplate_class setattributepaths index setAttributePaths (String [] attributePaths) public void setAttributePaths (String [] attributePaths) This method sets attribute paths used inside tags in the document template. The attribute paths are represented in the form objectName.attributeName text/html 2023-05-03T04:56:16+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setattributevalue?rev=1683089776&do=diff index programmers_reference methods ientity_interface setattributevalue setAttributeValue (String, Object) public void setAttributeValue (String attributeName, Object value) throws InvalidParameterException This method sets the value of the specified attribute. The attribute must not be a reference. Use the setReferences method to set references. text/html 2023-05-03T04:56:03+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setbinarydata?rev=1683089763&do=diff index programmers_reference methods iexecutionengine_interface setbinarydata setBinaryData (IProcess, String, Long, String, byte[]) public void setBinaryData (IProcessparent, StringentityName, Long id, String attributeName, byte[] data) throws AccessDeniedException, ExecutionException; This method sets the data of the specified binary attribute of the specified instance of the business object. This method allows clearing binary attribute (if “data” is null). Normally if binary data is provide… text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setelementvalue?rev=1749700855&do=diff index programmers_reference methods report_scriptlets ireportenvironment_interface setelementvalue setElementValue (String, Object) public** void setElementValue (String elementName, Object value) throws Exception This method sets the current value of the report element with the specified name. The element must be an element with a scriptlet attached (text or image). Each element in the report may be given a name in its Properties dialog. If the element’s name is not specified text/html 2023-05-03T04:55:01+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setprogress?rev=1683089701&do=diff index programmers_reference methods iexecutioncontext_interface setprogress setProgress (int) public void setProgress (int progress) This method can be used to set the progress of the custom process component. The system will use this number when the operator inquires about the progress of the process. Parameters progress text/html 2023-05-03T04:54:38+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/setreferences?rev=1683089678&do=diff index programmers_reference methods ientity_interface setreferences index setReferences (String, ObjectReference []) public void setReferences (String attributeName, ObjectReference [] refs) throws InvalidParameterException This method sets references of the business object or notification. Note that if the updateEntity method of the text/html 2023-05-03T04:54:19+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/settimeout?rev=1683089659&do=diff index programmers_reference methods iexecutioncontext_interface settimeout index setTimeout (long) public void setTimeout (long timeout) Set the number of milliseconds that the system will wait before timing out the process if it is suspended. Parameters timeoutthe timeout value in milliseconds. If the value is –1 the process never times out. text/html 2023-05-03T04:54:00+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/sttartediting?rev=1683089640&do=diff index programmers_reference methods ichannelsettingseditor startediting startEditing (int, java.awt.Component, Properties, boolean) public Properties startEditing (int intelligenceType, java.awt.Component parent, Properties initialSettings, boolean viewOnly) throws Exception This method is called when the user presses the Settings button to start editing the settings specific to the channel. The method is supposed to invoke the user interface (for example, a dialog) that would show the initi… text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/supportsservicediscovery?rev=1749700855&do=diff index programmers_reference methods ichanneltype_interface supportsservicediscovery supportsServiceDiscovery () public boolean supportsServiceDiscovery () AwareIM supports service discovery mechanism – it may send a special request through the channel to find out which services are supported by an intelligent business object. The text/html 2023-05-03T04:53:22+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/tosql?rev=1683089602&do=diff index programmers_reference methods ifunctionlibrary_interface tosql toSQL (String, Collection, ISQLBuilderHelper) public String toSQL (String functionName, Collection parameters, ISQLBuilderHelper helper) throws Exception This method must return the SQL representation of the function if it supports one. The SQL representation is essential if a function is to be used in queries. If the SQL representation is not provided it will not be possible to use the function in queries. See also an exam… text/html 2023-05-03T04:53:02+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/updateentity?rev=1683089582&do=diff index programmers_reference methods iexecutionengine_interface updateentity updateEntity (IProcess, IEntity, String [], Object [], ChangedReference []) public void updateEntity (IProcessparent, IEntity entity, String [] changedAttributes, Object [] oldValues, ChangedReference [] changedRefs) throws ServerTimeOutException, AccessDeniedException, ExecutionException; text/html 2025-06-12T04:00:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://www.awareim.com/dokuwiki/pr_methods/validatesettings?rev=1749700855&do=diff index programmers_reference methods ichannelsettingseditor validatesettings index validateSettings (Properties, int) public void validateSettings (Properties settings, int intelligenceType) throws Exception This method is called when changes to the business object (which include changes to the channels) are committed. The editor is supposed to validate the settings and throw the exception with the appropriate message if the settings are invalid. The validation should happen during editing as …