- getAccessType() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the access type of the Param, for example "readonly".
- getAccountId() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the account id.
- getActionType(String) - Static method in enum com.hcl.voltmx.middleware.common.ActionType
-
Returns the
ActionType
of the given
action or null if the action given is invalid
- getActionType() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictResolutionResult
-
Returns the
ActionType
which
represents the operation to be performed on object
- getAdditionalMetadata() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the collection of all additional metadata of the event.
- getAdditionalMetadata(String) - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the additional metadata with specified name.
- getAllClientAppProperties() - Method in class com.hcl.voltmx.middleware.api.ConfigurableParametersHelper
-
Gets all client app parameter name value pairs.
- getAllDatasets() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the read-only list of all Datasets of this Record/Result
object.
- getAllParams() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the read-only list of all Params of this Record/Result object.
- getAllRecords() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the read-only list of all inner Records of this Record/Result
object.
- getAllRecords() - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Gets the read-only list of Records contained in the Dataset.
- getAllServerProperties() - Method in class com.hcl.voltmx.middleware.api.ConfigurableParametersHelper
-
Gets all server parameter name value pairs.
- getAppAttributes() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the application attributes.
- getAppId() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the Foundry application id.
- getAppId() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the Foundry application id.
- getAppName() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the Foundry application name.
- getAppName() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the Foundry application name.
- getAttribute(String) - Method in interface com.hcl.voltmx.middleware.api.processor.SessionHandler
-
Returns the object bound with the specified name in this session, or null
if no object is bound under the name.
- getAttribute(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets an attribute value, an Object previously stored in the scope of this
request.
- getAttribute(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets an attribute value, an Object previously stored in the scope of this
response.
- getAttribute(String) - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets an attribute value, an Object previously stored in the scope of this
session.
- getAttributeNames() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets name of all the attributes stored in the scope of this request.
- getAttributeNames() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets name of all the attributes stored in the scope of this response.
- getAttributeNames() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets name of all the attributes stored in the scope of this session.
- getCacheId() - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
Gets the cache id.
- getCharsetEncoding() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the character encoding of the response.
- getClientAction() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
- getClientAppProperty(String) - Method in class com.hcl.voltmx.middleware.api.ConfigurableParametersHelper
-
Gets the client app param value corresponding to paramName.
- getCode() - Method in enum com.hcl.voltmx.middleware.exceptions.Opstatus
-
Gets the opstatus code.
- getCodeAsString() - Method in enum com.hcl.voltmx.middleware.exceptions.Opstatus
-
Gets the opstatus code as string.
- getConfigurableParametersHelper() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the helper class to access the Server and Client App parameters that
were set by the developer in admin console.
- getConflictType() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the type of the conflict
- getCookies() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the cookies from of the request.
- getCookies() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the list of response cookies.
- getCopy() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
FOR INTERNAL USE ONLY.
- getCreationTime() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the session creation time.
- getData() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the data of the event.
- getDatabaseTransactionManager() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the database transaction manager object which is used to execute
services in a transaction
- getDatasetById(String) - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the Dataset with given id from this Record/Result object.
- getDatasets() - Method in class com.hcl.voltmx.middleware.api.ServiceOutputWrapper
-
Gets the list of service output datasets.
- getDatasets() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- getDataSets() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- getDelayNotificationInMilliseconds() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the time in milliseconds to delay the notification of the event.
- getDeltaContextFieldName() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the name of the field representing the lastupdate tracking value.
- getDeviceCookies() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the list of response cookies that will be sent to the client (device).
- getDeviceHeaders() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets map of all headers that will be sent to client (device).
- getDeviceId() - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
Gets the device id.
- getDeviceRequestData() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Returns the request data which will have information like device id,
request id, cache id and reporting params about current service.
- getEISCookieByName(String) - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the cookie with the specified name from the session.
- getEISCookieByName_Domain_Path(String, String, String) - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the cookie with the specified name, domain and path.
- getEISCookies() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets a read-only copy of list of cookies present in this session.
- getEmailId() - Method in class com.hcl.voltmx.middleware.api.UserProfile
-
Gets the email id
- getErrMsgParamValue() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
Gets errmsg param value.
- getEscapeXMLValue() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the escaped (or encoded) value the Param so that it is safe to use it
in XML strings.
- getEventManager() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the event manager object which is used to subscriber and unsubscribe
event subscriber.
- getEventNotifier() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the events notifier object which is used to notify events and check
status of events.
- getFields() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the unmodifiable set of all the field of the current object
- getFirstName() - Method in class com.hcl.voltmx.middleware.api.UserProfile
-
Gets the first name
- getFormat() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the format or sub-type of the Param, for example "Currency".
- getFormatValue() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the format value of the Param, for example "YYYY-MM-DD" for date.
- getHeader(String) - Method in interface com.hcl.voltmx.middleware.api.processor.HeadersHandler
-
Returns the value of the specified request header as a String.
- getHeader(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the header value of the specified header name.
- getHeaderMap() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the map of all headers.
- getHeaderNames() - Method in interface com.hcl.voltmx.middleware.api.processor.HeadersHandler
-
Returns a set of all the header names present in the request.
- getHeaders() - Method in class com.hcl.voltmx.middleware.api.ServiceOutputWrapper
-
Gets the list of service output headers.
- getHeaders() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the map of all headers from the response.
- getHeadersHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryRequestManager
-
Returns the request headers handler.
- getHeadersHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryResponseManager
-
Returns the response headers handler.
- getHttpMethod() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the HTTP method.
- getHttpMethod() - Method in interface com.hcl.voltmx.middleware.api.OperationDataBuilder
-
Returns the HTTP method.
- getHttpStatusCodeParamValue() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
Gets httpStatusCode param value.
- getId() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the unique id of the event.
- getId() - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Gets the unique id of the Dataset.
- getId() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Gets the id of the Record.
- getId() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the session Id.
- getIdentityHandler() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the identity handler which provided access to identity user profile
and attributes.
- getIdOfAllDatasets() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the id of all Datasets in this Record/Result object.
- getIdOfAllRecords() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the id of all inner Records in this Record/Result object.
- getIndex() - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Gets the index of the Dataset.
- getIndex() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Gets the index of the Record in its parent.
- getInstance() - Static method in class com.hcl.voltmx.middleware.ehcache.ResultCacheImpl
-
Deprecated.
- getVoltmxCustomMetrics() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
FOR INTERNAL USE ONLY.
- getLastAccessedTime() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the time when the session was last accessed.
- getLastName() - Method in class com.hcl.voltmx.middleware.api.UserProfile
-
Gets the last name
- getLocation() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the redirected location URL if the response was a 302 redirect.
- getMaxInactiveInterval() - Method in interface com.hcl.voltmx.middleware.session.Session
-
Gets the maximum time the session can be inactive.
- getMessage(Object...) - Method in enum com.hcl.voltmx.middleware.exceptions.Opstatus
-
Gets the message corresponding to this opstatus.
- getMonitoringData() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the monitoring data of the event.
- getName() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the name of the Param.
- getNameOfAllParams() - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the name of all Params in this Record/Result object.
- getObjectId() - Method in class com.hcl.voltmx.middleware.api.events.ObjectServiceEvent
-
Gets the object id.
- getObjectId() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the object id.
- getObjectId() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the name of the object
- getObjectValue() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the value of the Param.
- getOperation() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Deprecated.
- getOperationData() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Returns the operation data which will have information like service id,
version, operation about current service.
- getOperationDataBuilder() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the operation data builder.
- getOperationId() - Method in class com.hcl.voltmx.middleware.api.events.AbstractServiceEvent
-
Gets the operation id.
- getOperationId() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the operation id.
- getOpstatusParamValue() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
Gets opstatus param value.
- getOrder() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Gets the order of the Record in its parent.
- getOriginalRequest() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Deprecated.
- getParam(String) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Gets the Param with given param name from the Record.
- getParamByName(String) - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the Param with given param name from this Record/Result object.
- getParameter(String) - Method in interface com.hcl.voltmx.middleware.api.processor.QueryParamsHandler
-
Returns the value of a query param with given name.
- getParameter(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the request parameter passed in as post parameter or query string.
- getParameterNames() - Method in interface com.hcl.voltmx.middleware.api.processor.QueryParamsHandler
-
Returns a set of all query param names present in the request query string.
- getParameterNames() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets name of all the request parameters.
- getParameterValues(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the request parameter passed in as post parameter or query string.
- getParamList() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- getParams() - Method in class com.hcl.voltmx.middleware.api.ServiceOutputWrapper
-
Gets the list of service output params.
- getParams() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- getParamValueByName(String) - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the value of the Param with given param name from this Record/Result
object.
- getParentServiceName() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the parent service name.
- getPayloadAsJson() - Method in interface com.hcl.voltmx.middleware.api.processor.PayloadHandler
-
Gets the payload as JSON
- getPayloadHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryRequestManager
-
Returns the request payload handler.
- getPayloadHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryResponseManager
-
Returns the response payload handler
- getPrimaryKeys() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the unmodifiable list of primary keys of the current object
- getProducer() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the producer of the event.
- getQueryParams() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the unmodifiable map of queryPrams
- getQueryParamsHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryRequestManager
-
Returns the query params handler.
- getQueryString() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
- getRecord(int) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Gets the Record at the specified index from the list of Records contained
in the Dataset.
- getRecordById(String) - Method in class com.hcl.voltmx.middleware.dataobject.AbstractRecord
-
Gets the inner Record with given id from this Record/Result object.
- getRecordOrder(int) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
- getRecords() - Method in class com.hcl.voltmx.middleware.api.ServiceOutputWrapper
-
Gets the list of service output records.
- getRecords() - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
- getRecords() - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- getRecords() - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- getRemoteAddr() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the IP address of the client or last proxy that sent the request.
- getReportingParams() - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
Gets the reporting params.
- getRequestBuilder(OperationData) - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the service request builder.
- getRequestId() - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
Get the request id.
- getResolveddata() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictResolutionResult
-
Returns the resolved data after conflict resolution
- getResponse() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the response content.
- getResultCache() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the ResultCache interface.
- getSecurityAttributes() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the security attributes using default provider name.
- getSecurityAttributes(String, boolean) - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the security attributes for the given provider name.
- getSecurityLevel() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the security level for this operation.
- getSecurityName() - Method in enum com.hcl.voltmx.middleware.api.OperationSecurityLevel
-
Gets the underline security name.
- getServerAction() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
- getServerProperty(String) - Method in class com.hcl.voltmx.middleware.api.ConfigurableParametersHelper
-
Gets the server param value corresponding to paramName.
- getServiceId() - Method in class com.hcl.voltmx.middleware.api.events.AbstractServiceEvent
-
Gets the service id.
- getServiceId() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the service id.
- getServiceId() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the objectService name of the current object
- getServiceMonitor() - Method in interface com.hcl.voltmx.middleware.api.ServicesManager
-
Gets the ServiceMonitor
instance to capture the service monitoring
information in custom code.
- getServiceOutputWrapper() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
FOR INTERNAL USE ONLY.
- getServicesManager() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
- getServicesManager() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryRequestManager
-
Returns the services manager.
- getServicesManager(HttpServletRequest) - Static method in class com.hcl.voltmx.middleware.api.ServicesManagerHelper
-
Gets an instance of Services Manager to use in custom code.
- getServicesManager(ServletContext) - Static method in class com.hcl.voltmx.middleware.api.ServicesManagerHelper
-
Gets an instance of Services Manager to use in custom code.
- getServicesManager() - Static method in class com.hcl.voltmx.middleware.api.ServicesManagerHelper
-
Gets an instance of Services Manager to use in custom code.
- getServicesManager() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Meant for use in Custom code
- getSession() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the session associated with the request.
- getSession(boolean) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the session associated with the request.
- getSessionHandler() - Method in interface com.hcl.voltmx.middleware.api.processor.manager.FoundryRequestManager
-
Returns the session handler.
- getSoftDeleteActiveValue() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the value which represents the non deleted value of the softDelete
field.
- getSoftDeleteDeletedValue() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the value which represents the delete value of the softDelete
field.
- getSoftDeleteFieldName() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the softDelete field name of the current object.
- getSource() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets a map of parameter key and parameter values.
- getStatus() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the current status of the event.
- getStatusCode() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Gets the (HTTP) status code of the back-end service call.
- getTimestamp() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the timestamp of the event in milliseconds.
- getTopic() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the name or topic of the event.
- getType() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the type of the event.
- getType() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the type of the Param, for example "boolean", or "int", or
"collection".
- getUploadedFile(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets the specified file that was uploaded.
- getUploadedFileNames() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets name of all the files that have been received in this request.
- getUploadedFiles() - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Gets all the uploaded files.
- getUserAttributes() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets user attributes using default provider name.
- getUserAttributes(String) - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the user attributes for the given provider name.
- getUserId() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the user id from identity user profile.
- getUserId() - Method in class com.hcl.voltmx.middleware.api.UserProfile
-
Gets the user id
- getUserProfile() - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Gets the
UserProfile
which contain information like user id, first
name, last name and email id.
- getUserProfile() - Method in interface com.hcl.voltmx.middleware.api.processor.IdentityHandler
-
Gets the user profile from identity user profile.
- getValue() - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Gets the value of the Param.
- getVerison() - Method in interface com.hcl.voltmx.middleware.api.OperationDataBuilder
-
Deprecated.
- getVersion() - Method in class com.hcl.voltmx.middleware.api.events.AbstractServiceEvent
-
Gets the version.
- getVersion() - Method in class com.hcl.voltmx.middleware.api.OperationData
-
Gets the version of the service.
- getVersion() - Method in interface com.hcl.voltmx.middleware.api.OperationDataBuilder
-
Gets the service version.
- getVersion() - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Returns the version of the Application being invoked
- ServiceMonitor - Interface in com.hcl.voltmx.middleware.api
-
The ServiceMonitor
interface used to capture service monitoring data
from custom code.
- ServiceOutputWrapper - Class in com.hcl.voltmx.middleware.api
-
Wrapper for various service output data.
- ServiceOutputWrapper(ServiceOutput) - Constructor for class com.hcl.voltmx.middleware.api.ServiceOutputWrapper
-
- ServiceRequest - Interface in com.hcl.voltmx.middleware.api
-
The service request interface.
- ServiceRequestBuilder - Interface in com.hcl.voltmx.middleware.api
-
The builder for service request.
- ServicesManager - Interface in com.hcl.voltmx.middleware.api
-
ServicesManager is an interface that provides custom code access to
other helper classes.
- ServicesManagerHelper - Class in com.hcl.voltmx.middleware.api
-
ServicesManagerHelper is a helper class that provides ServicesManager
access in custom code (like event subscriber, custom filters, custom
servlets).
- Session - Interface in com.hcl.voltmx.middleware.session
-
An abstraction over the actual server session which may or may not have an
underlying HTTP session.
- SessionHandler - Interface in com.hcl.voltmx.middleware.api.processor
-
Handler to perform operations on request session.
- setAccessType(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the access type of the Param, for example "readonly".
- setActionType(ActionType) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictResolutionResult
-
- setAttribute(String, Object) - Method in interface com.hcl.voltmx.middleware.api.processor.SessionHandler
-
Binds an object to this session, using the name specified.
- setAttribute(String, T) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Sets an attribute value, an Object storied in the scope of this request.
- setAttribute(String, T) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets an attribute value, an Object storied in the scope of this response.
- setAttribute(String, Object) - Method in interface com.hcl.voltmx.middleware.session.Session
-
Sets an attribute value, an Object storied in the scope of this session.
- setCacheId(String) - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
- setCharsetEncoding(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the character encoding of the response.
- setClientAction(ActionType) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the ActionType of the client data
- setConflictType(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the type of the conflict
- setCookies(List<Cookie>) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the list of response cookies.
- setDataset(Dataset) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setDataSet(Dataset) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setDatasets(ArrayList<Dataset>) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setDataSets(ArrayList<Dataset>) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setDelayNotificationInMilliseconds(int) - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Sets the time in milliseconds to delay the notification of the event.
- setDeltaContextFieldName(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the name of the field representing the last update tracking value.
- setDeviceCookies(List<Cookie>) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets list of response cookies sent to the client (device).
- setDeviceHeaders(Map<String, String>) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets map of all headers that will be sent to client (device).
- setDeviceId(String) - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
- setFields(Set<String>) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the fields of the current object
- setFormat(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the format or sub-type of the Param, for example "Currency".
- setFormatValue(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the format value of the Param, for example "YYYY-MM-DD" for date.
- setHeaders(Map<String, String>) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the map of all headers in the response.
- setId(String) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Sets the id for the Dataset.
- setId(String) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Sets the id of the Record.
- setID(String) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setIndex(int) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
Sets the index for the Dataset.
- setIndex(int) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Sets the index of the Record in its parent.
- setInstance(ResultCacheImpl) - Static method in class com.hcl.voltmx.middleware.ehcache.ResultCacheImpl
-
Deprecated.
- setLocation(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the redirected location URL when there is 302 redirect.
- setMaxInactiveInterval(int) - Method in interface com.hcl.voltmx.middleware.session.Session
-
Sets the maximum inactive interval to the specified value.
- setName(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the name of the Param.
- setObjectId(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the name of the object
- setObjectValue(Object) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the value of the Param as proper object.
- setOffline(boolean) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets whether the object is offline
- setOrder(int) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
Sets the order of the Record in its parent.
- setParam(Param) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setParam(Param) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setParamList(ArrayList<Param>) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setParams(ArrayList<Param>) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setPrimaryKeys(List<String>) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the list of primary keys of the object
- setProducer(String) - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Sets the producer of the event.
- setQueryParams(Map<String, String>) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the map of queryPrams
- setRecord(Record) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
- setRecord(Record) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setRecord(Record) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setRecords(ArrayList<Record>) - Method in class com.hcl.voltmx.middleware.dataobject.Dataset
-
- setRecords(ArrayList<Record>) - Method in class com.hcl.voltmx.middleware.dataobject.Record
-
- setRecords(ArrayList<Record>) - Method in class com.hcl.voltmx.middleware.dataobject.Result
-
- setReportingParams(String) - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
- setRequestId(String) - Method in class com.hcl.voltmx.middleware.api.DeviceRequestData
-
- setResponse(String) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the content of this response.
- setServerAction(ActionType) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the ActionType of the server data
- setServerDataSoftDeleted(boolean) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets whether the current record if present at backend server is soft
deleted or not
- setServiceId(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the objectService name of the current object
- setServicesManagerSupplier(MWSupplier) - Static method in class com.hcl.voltmx.middleware.api.ServicesManagerHelper
-
FOR INTERNAL USE ONLY.
- setSession(Session) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerRequest
-
Sets a session for this request.
- setSoftDeleteActiveValue(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the value which represents the non deleted value of the softDelete
field
- setSoftDeleteDeletedValue(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the value which represents the delete value of the softDelete field.
- setSoftDeleteFieldName(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the softDelete field name of the current object.
- setStatus(EventStatus) - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Sets the status of the event.
- setStatusCode(int) - Method in interface com.hcl.voltmx.middleware.controller.DataControllerResponse
-
Sets the (HTTP) status code of the back-end service call.
- setType(String) - Method in class com.hcl.voltmx.middleware.api.events.EventData
-
Sets the type of the event.
- setType(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the type of the Param, for example "boolean", or "int", or
"collection".
- setValue(String) - Method in class com.hcl.voltmx.middleware.dataobject.Param
-
Sets the value of the Param.
- setVersion(String) - Method in class com.hcl.voltmx.middleware.customconflict.ConflictContext
-
Sets the version of the Application being invoked
- STRING_CONST - Static variable in class com.hcl.voltmx.middleware.dataobject.Param
-
Constant for "string" parameter type.
- subscribe(String, EventSubscriber) - Method in interface com.hcl.voltmx.middleware.api.events.EventManager
-
Subscribes the given event subscriber to all events with specified name or
topic.