- get() - Static method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the context of the current request.
- getAllHeaders() - Method in interface com.veeva.vault.sdk.api.csv.CsvHeaders
-
Returns a list of CSV headers.
- getAttribute(String, MessageAttributeValueType<T>) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
- getColumnIndex(String) - Method in interface com.veeva.vault.sdk.api.csv.CsvHeaders
-
Returns the index of the given column name.
- getConfigurationContext() - Method in interface com.veeva.vault.sdk.api.action.DocumentActionContext
-
Retrieves configuration data, such as parameter values set by an Admin, for the action being executed.
- getConfigurationContext() - Method in interface com.veeva.vault.sdk.api.action.RecordActionContext
-
Retrieve configuration data, such as parameter values set by an Admin, for the action being executed.
- getConnectionId() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the ID of the Connection record associated with this Message.
- getConnectionName() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResult
-
Retrieves the API Name (api_name__sys
) of the Connection record associated with this Message.
- getCurrentUserId() - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the user which originated the activity which caused the Vault Java SDK Code to run.
- getDocumentIds() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsDocumentResponse
-
Retrieves the IDs of documents which are missing one or more users provided to the original service call.
- getDocumentRole(DocumentVersion) - Method in interface com.veeva.vault.sdk.api.role.GetDocumentRolesResponse
-
- getDocumentRoles(List<DocumentVersion>, String) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- GetDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getDocumentVersion() - Method in interface com.veeva.vault.sdk.api.role.DocumentRole
-
Retrieves the document for which this document role applies to.
- getDocumentVersionId() - Method in interface com.veeva.vault.sdk.api.document.PositionalDocumentVersionId
-
Retrieves the DocumentVersion ID.
- getDocumentVersions() - Method in interface com.veeva.vault.sdk.api.action.DocumentActionContext
-
Retrieves the document versions this action is executing against.
- getDocumentVersions() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsDocumentResponse
-
Retrieves the documents which are missing one or more users provided to the original service call.
- getError() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationError
-
Returns the error which occurred at a particular element of a batch operation.
- getError() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
Retrieves errors about any issues encountered when putting the
Message
onto the queue.
- getErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationResponse
-
Returns the List of errors that occurred when processing the batch.
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
- getGroupById(String) - Method in interface com.veeva.vault.sdk.api.group.GetGroupsResponse
-
Retrieve a Group object for the given Group ID.
- getGroupByName(String) - Method in interface com.veeva.vault.sdk.api.group.GetGroupsResponse
-
Retrieve a Group object for the given Group name.
- getGroupInDocumentRoles(Group, List<DocumentRole>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- GetGroupInDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getGroupInRecordRoles(Group, List<RecordRole>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
For a given group, returns a GetGroupInRecordRolesResponse object that can be used to check if the group is in a
particular record role.
- GetGroupInRecordRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getGroups() - Method in interface com.veeva.vault.sdk.api.role.DocumentRole
-
Retrieves a list of groups which are manually assigned to this document role.
- getGroups() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves a List of groups which are manually assigned to this RecordRole.
- getGroupsAdded() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of groups added to the role.
- getGroupsbyIds(List<String>) - Method in interface com.veeva.vault.sdk.api.group.GroupService
-
Retrieves GetGroupsResponse for the given List of group IDs.
- getGroupsByNames(List<String>) - Method in interface com.veeva.vault.sdk.api.group.GroupService
-
Retrieves GetGroupsResponse for the given List of group names.
- getGroupsRemoved() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of groups removed from the role.
- GetGroupsResponse - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve Groups.
- getHeaderNames() - Method in interface com.veeva.vault.sdk.api.http.HttpResponse
-
Retrieves a list of HTTP response header names.
- getHeaders() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
- getHeaderValues(String) - Method in interface com.veeva.vault.sdk.api.http.HttpResponse
-
Retrieves a list of HTTP response header values for the given header name.
- getHttpOperationErrorType() - Method in interface com.veeva.vault.sdk.api.http.HttpOperationError
-
Type of error during an HTTP operation execution.
- getHttpResponse() - Method in interface com.veeva.vault.sdk.api.http.HttpOperationError
-
Result of HTTP operation execution when there is an error.
- getHttpStatusCode() - Method in interface com.veeva.vault.sdk.api.http.HttpResponse
-
Retrieves the HTTP status code.
- getId() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve group ID.
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationError
-
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.PositionalResult
-
- getJobName() - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
- getJsonArray() - Method in interface com.veeva.vault.sdk.api.json.JsonData
-
Returns the top-level
JsonArray
for the JSON data.
- getJsonObject() - Method in interface com.veeva.vault.sdk.api.json.JsonData
-
Returns the top-level
JsonObject
for the JSON data.
- getLabel() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve the group label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
This method retrieves the picklist UI label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
-
This method retrieves the picklist label.
- getLifecycleRole() - Method in interface com.veeva.vault.sdk.api.role.DocumentRole
-
Retrieves the lifecycle role for which this document role applies to.
- getLifecycleRoleLabel() - Method in interface com.veeva.vault.sdk.api.role.LifecycleRole
-
Retrieves the document lifecycle role label, for example, Approver.
- getLifecycleRoleName() - Method in interface com.veeva.vault.sdk.api.role.LifecycleRole
-
Retrieves the document lifecycle role name, for example, approver__c
.
- getLineEnding() - Method in enum com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the line ending as a
String
.
- getMessage() - Method in interface com.veeva.vault.sdk.api.core.ErrorResult
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.http.HttpOperationError
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves this Message object.
- getMessageId() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves this message ID.
- getMessageId() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResult
-
Retrieves the ID of this Message.
- getMessageItems() - Method in interface com.veeva.vault.sdk.api.queue.Message
-
- getMissingAssignments(List<DocumentVersion>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- getMissingAssignments(List<Record>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
- GetMissingAssignmentsDocumentResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check which users or documents are missing assignments in a particular role.
- GetMissingAssignmentsRecordResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check which users or records are missing assignments in a particular role.
- getName() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve the group name.
- getNew() - Method in interface com.veeva.vault.sdk.api.data.RecordChange
-
Retrieves the new data for the Record.
- getNumRows() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
Returns the total number of rows in the CSV data.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.data.Record
-
Retrieves the name of the object this Record belongs to.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the name of the object for which the trigger is invoked.
- getOld() - Method in interface com.veeva.vault.sdk.api.data.RecordChange
-
Retrieves the pre-existing data for the Record.
- getPicklist(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
This method returns a picklist object, which can be used to
retrieve picklist information.
- getPicklistValue(String) - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
This method retrieves a
PicklistValue
object for a specific picklist value name.
- getPutMessageResults() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
Retrieves a list of PutMessageResult objects.
- getQueueName() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the name of the queue which received this Message.
- getRecord() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves the Record object's name and record ID.
- getRecordChanges() - Method in interface com.veeva.vault.sdk.api.data.RecordTriggerContext
-
Retrieves the changed records which caused the trigger to fire.
- getRecordEvent() - Method in interface com.veeva.vault.sdk.api.data.RecordTriggerContext
-
Retrieves the
RecordEvent
that occurred which caused this trigger to fire.
- getRecordId() - Method in interface com.veeva.vault.sdk.api.data.PositionalRecordId
-
Retrieves the Record ID.
- getRecordIds() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsRecordResponse
-
Retrieves the IDs of records which are missing one or more users provided to the original service call.
- getRecordRole(Record, String) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
Retrieves RecordRole for a given record and role.
- getRecordRole(Record) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
- getRecordRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the RecordRole where a change applied.
- getRecordRoleChanges() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the changed record roles which caused the trigger to fire.
- getRecordRoleEvent() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the
RecordRoleEvent
that occurred which caused this trigger to fire.
- getRecordRoles(List<Record>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
- getRecordRoles(List<Record>, String) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
Retrieves GetRecordRolesResponse for the given List of records and for a particular role.
- GetRecordRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getRecords() - Method in interface com.veeva.vault.sdk.api.action.RecordActionContext
-
Retrieve the object records this action is executing against.
- getRecords() - Method in interface com.veeva.vault.sdk.api.data.ReadRecordsResponse
-
Returns a Map of retrieved Records where
key
is the Record
id
and
value
is
Record
.
- getRecords() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsRecordResponse
-
Retrieves the records which are missing one or more users provided to the original service call.
- getRemoteQueueName() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the name of the queue which sent this Message.
- getRemoteVaultId() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieve the ID of the vault which sent this Message.
- getResponseBody() - Method in interface com.veeva.vault.sdk.api.http.HttpResponse
-
Retrieves the HTTP response body.
- getResultCount() - Method in interface com.veeva.vault.sdk.api.query.QueryResponse
-
Retrieves the total number of results satisfying the query.
- getRole() - Method in interface com.veeva.vault.sdk.api.role.LifecycleRole
-
Retrieves the application role associated with the document lifecycle role.
- getRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves the Role assigned to this RecordRole.
- getRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the Role in the record role change.
- getRoleId() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role ID.
- getRoleLabel() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role label, for example, Approver.
- getRoleName() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role name, for example, approver__c
.
- getRow(int) - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
Returns a
Row
of data at a given index.
- getSize() - Method in interface com.veeva.vault.sdk.api.csv.Row
-
Returns the number of values contained in the row.
- getSize() - Method in interface com.veeva.vault.sdk.api.json.JsonArray
-
Returns the number of elements in the array.
- getSourceRecordId() - Method in interface com.veeva.vault.sdk.api.data.Record
-
Retrieves the id
of the source Record if the new Record is being copied from another Record.
- getSubqueryResponse(String) - Method in interface com.veeva.vault.sdk.api.query.QueryResult
-
Returns the results from a nested SELECT-FROM for the specified inbound relationship in a
Left Outer Join Query.
- getSubtype() - Method in interface com.veeva.vault.sdk.api.core.ErrorResult
-
Returns machine-readable error subtype
An error message of this form can be used to make programmatic decisions.
This value is set by Vault Java SDK Code.
- getSuccesses() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationResponse
-
Returns results for the items that were successfully processed in the batch operation.
- getSuccesses() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordsResponse
-
Deprecated.
Returns successfully deleted records.
- getSuccesses() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordsResponse
-
Deprecated.
Returns successfully saved records.
- getSuccesses() - Method in interface com.veeva.vault.sdk.api.document.DeleteDocumentVersionsResponse
-
Retrieves deleted document or document version IDs.
- getSuccesses() - Method in interface com.veeva.vault.sdk.api.document.SaveDocumentVersionsResponse
-
Retrieves saved document IDs.
- getType() - Method in interface com.veeva.vault.sdk.api.core.ErrorResult
-
Returns a machine-readable error type
An error message of this form can be used to make programmatic decisions.
If the error is raised by Vault Java SDK Code, for example by calling
RecordChange.setError(String, String)
,
type
will always be
SDK_ERROR
.
The
subtype
value specified by Vault Java SDK Code can be retrieved using
ErrorResult.getSubtype()
- getType() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve the group Type.
- getUserInDocumentRoles(String, List<DocumentRole>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- GetUserInDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check if a particular user is assigned to a given document role.
- getUserInputRecord() - Method in interface com.veeva.vault.sdk.api.action.DocumentActionContext
-
Retrieves user input submitted during action execution.
- getUserInputRecord() - Method in interface com.veeva.vault.sdk.api.action.RecordActionContext
-
Retrieves user input submitted during action execution.
- getUserInRecordRoles(String, List<RecordRole>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
For a given user ID, returns a GetUserInRecordRolesResponse object that can be used to check if the user is in a
particular record role.
- GetUserInRecordRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check user membership in RecordRole.
- getUsers() - Method in interface com.veeva.vault.sdk.api.role.DocumentRole
-
Retrieves a list of user IDs which are manually assigned to this document role.
- getUsers() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsDocumentResponse
-
Retrieves the IDs of users which are missing in one or more documents provided to the original service call.
- getUsers() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsRecordResponse
-
Retrieves the IDs of users which are missing in one or more records provided to the original service call.
- getUsers() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves a List of user IDs which are manually assigned to this RecordRole.
- getUsersAdded() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of users added to the role.
- getUsersRemoved() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of users removed from the role
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.action.ConfigurationContext
-
Get a parameter's value.
- getValue(String, RequestContextValueType<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the value identified by the given name
from the request context.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the value identified by the given name
from the request context.
- getValue(int, CsvValueType<T>) - Method in interface com.veeva.vault.sdk.api.csv.Row
-
Retrieves a value at a column specified by its index.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.data.Record
-
Retrieves the value of the specified Record field.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Retrieves the value of the specified document field.
- getValue(int, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonArray
-
Retrieves a value contained at the given index.
- getValue(String, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonObject
-
Retrieves the value of an attribute with the given name.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryResult
-
Retrieves value of the given field.
- getValueByName(String, CsvValueType<T>) - Method in interface com.veeva.vault.sdk.api.csv.Row
-
Retrieves a value at a column specified by its name.
- Group - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve group related information.
- GroupService - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve GetGroupsResponse and check user membership in group.
- GroupType - Enum in com.veeva.vault.sdk.api.group
-
Valid values for group classifications.
- readCsv(String) - Method in interface com.veeva.vault.sdk.api.csv.CsvService
-
Parses a CSV string that and returns
CsvData
.
- readCsv(String, CsvReadParameters) - Method in interface com.veeva.vault.sdk.api.csv.CsvService
-
Parses a CSV string that and returns
CsvData
.
- readJson(String) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Parses the JSON string and returns a
JsonData
.
- readRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Retrieves the requested Record with all fields and values inside the current transaction.
- ReadRecordsResponse - Interface in com.veeva.vault.sdk.api.data
-
- Record - Interface in com.veeva.vault.sdk.api.data
-
Represents a Vault object record.
- RecordAction - Interface in com.veeva.vault.sdk.api.action
-
- RecordActionContext - Interface in com.veeva.vault.sdk.api.action
-
Contains contextual data about a record action during execution.
- RecordActionInfo - Annotation Type in com.veeva.vault.sdk.api.action
-
Indicates a class is a record action.
- RecordBatchOperation - Interface in com.veeva.vault.sdk.api.data
-
Batch Operation to perform on records.
- RecordChange - Interface in com.veeva.vault.sdk.api.data
-
Represents a Record that is being modified.
- RecordEvent - Enum in com.veeva.vault.sdk.api.data
-
Contains valid Event values to specify when the trigger occurs.
- RecordRole - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve information in a RecordRole.
- RecordRoleChange - Interface in com.veeva.vault.sdk.api.role
-
Represents changes applied to a record role.
- RecordRoleEvent - Enum in com.veeva.vault.sdk.api.role
-
Contains valid Event values to specify when the trigger occurs.
- RecordRoleService - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve and update
RecordRole
s.
- RecordRoleTrigger - Interface in com.veeva.vault.sdk.api.role
-
- RecordRoleTriggerContext - Interface in com.veeva.vault.sdk.api.role
-
- RecordRoleTriggerInfo - Annotation Type in com.veeva.vault.sdk.api.role
-
- RecordRoleUpdate - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to perform updates on a
RecordRole
.
- RecordService - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to create, read, update, and delete Records.
- RecordTrigger - Interface in com.veeva.vault.sdk.api.data
-
- RecordTriggerContext - Interface in com.veeva.vault.sdk.api.data
-
- RecordTriggerInfo - Annotation Type in com.veeva.vault.sdk.api.data
-
- REFERENCES - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
-
Represents a list of names (type
List
<
String
>) of object references.
- removeGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleUpdate
-
Removes groups from a role.
- removeGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleUpdate
-
Removes groups from a role.
- removeUsers(List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleUpdate
-
Removes a user from a role.
- removeUsers(List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleUpdate
-
Removes a user from a role.
- removeValue(String) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Removes the value
identified by the given name
from the request context.
- replaceAll(String, String, String) - Static method in class com.veeva.vault.sdk.api.core.StringUtils
-
Replaces each substring of input
that matches the given regular expression with the given replacement.
- replaceFirst(String, String, String) - Static method in class com.veeva.vault.sdk.api.core.StringUtils
-
Replaces the first substring of the input String that matches the given regular expression with the given replacement.
- RequestContext - Interface in com.veeva.vault.sdk.api.core
-
Provides access to the context in which the current request is made.
- RequestContextValue - Interface in com.veeva.vault.sdk.api.core
-
An interface for implementing a user-defined class to store data in a request context.
- RequestContextValueType<T> - Interface in com.veeva.vault.sdk.api.core
-
Type of data supported by the request context.
- Role - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve application role information.
- RollbackException - Exception in com.veeva.vault.sdk.api.core
-
Exception which, when thrown from Vault Java SDK code, aborts and rolls-back the in-progress transaction.
- RollbackException(String, String) - Constructor for exception com.veeva.vault.sdk.api.core.RollbackException
-
Builds the exception.
- rollbackOnErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
-
A convenience method to throw a runtime exception
if at least one error occurs during execution.
- Row - Interface in com.veeva.vault.sdk.api.csv
-
Represents an immutable row of data in a CSV.
- RowBuilder - Interface in com.veeva.vault.sdk.api.csv
-
- run(JobParameters) - Method in interface com.veeva.vault.sdk.api.job.JobService
-
- saveDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Save the specified DocumentVersions.
- SaveDocumentVersionsResponse - Interface in com.veeva.vault.sdk.api.document
-
- saveRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
- SaveRecordsResponse - Interface in com.veeva.vault.sdk.api.data
-
- send(HttpRequest, HttpResponseBodyValueType<T>) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Creates an operation to send the specified HTTP request and convert the response body to the given valueType
.
- send(HttpRequest, CsvReadParameters) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Creates an operation to send the specified HTTP request and convert the response body specifically
to CsvData
using the given custom csvReadParameters
.
- send(NotificationParameters, NotificationMessage) - Method in interface com.veeva.vault.sdk.api.notification.NotificationService
-
Sends a notification with message content.
- send(NotificationParameters, NotificationTemplate) - Method in interface com.veeva.vault.sdk.api.notification.NotificationService
-
Sends a notification with pre-defined template content.
- Service - Interface in com.veeva.vault.sdk.api.core
-
Marker interface for Vault Java SDK services.
- ServiceLocator - Class in com.veeva.vault.sdk.api.core
-
Retrieves an instance of a Vault Java SDK service.
- ServiceLocator() - Constructor for class com.veeva.vault.sdk.api.core.ServiceLocator
-
- setAttribute(String, Object) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
Sets an attribute with name and value.
- setAttributeWithToken(String, String) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
Sets a session attribute with the name and value of a valid message token.
- setBody(String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as a string.
- setBody(CsvData) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
- setBody(JsonObject) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
- setBody(JsonArray) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
- setBodyParam(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies a body param.
- setError(String, String) - Method in interface com.veeva.vault.sdk.api.data.RecordChange
-
Sets an error on this Record change.
- setError(String, String) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Sets an error on this RecordRole change.
- setEscape(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
-
Sets the character used to escape quote characters and other escape characters in individual values.
- setEscape(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
-
Sets the character used to escape special characters (e.g.
- setHasHeaders(boolean) - Method in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
-
Sets whether or not the CSV being read has headers.
- setHeader(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies an HTTP request header.
- setHeaders(List<String>) - Method in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
-
Sets the CSV headers (i.e.
- setLineEnding(LineEnding) - Method in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
-
Sets the
LineEnding
that separates individual rows.
- setMessage(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets the message text for the body of a notification email.
- setMessageItems(List<String>) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
Sets a list of message items for this Message.
- setMethod(HttpMethod) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies the HTTP method of the request.
- setNotificationText(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets the text of a notification, which appears in Home > Notifications in the Vault UI.
- setNotifyByEmailOnly(boolean) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Choose if this notification sends to user's email only.
- setQuerystringParam(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies a query string param.
- setQuote(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
-
Sets the character used to surround individual values.
- setQuote(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
-
Sets the character used to surround individual values.
- setRecipientsByGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the List of Groups who will receive the notification.
- setRecipientsByPersonIds(Set<String>) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the Person (person__sys
) record ids who will receive the notification.
- setRecipientsByRecordRoles(List<RecordRole>) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the List of RecordRoles who will receive the notification.
- setRecipientsByUserIds(Set<String>) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the recipients who will receive the notification.
- setResolveTokens(boolean) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies whether or not to resolve tokens used in headers, body parameters, and body.
- setSenderId(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the sender ID to provide values for sender tokens used in a notification template or message.
- setSeparator(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
-
Sets the character that separates values.
- setSeparator(char) - Method in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
-
Sets the character that separates values.
- setSubject(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets the subject of a notification email.
- setTemplateName(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationTemplate
-
Sets the notification template name (using the name of the notification template).
- setTimeout(int) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies the maximum time in milliseconds to wait for this HTTP request to complete execution.
- setTokenValue(String, String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets a custom token value.
- setTokenValue(String, String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationTemplate
-
Sets a custom token value.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Adds the given value
identified by the given name
to the request context.
- setValue(int, Object) - Method in interface com.veeva.vault.sdk.api.csv.RowBuilder
-
Sets a value on the row at the column specified by its index.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.data.Record
-
Sets the value for the specified Record field.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Sets the value for the specified document field.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Set the value of a job parameter.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.json.JsonObjectBuilder
-
Sets an attribute value on the building object.
- setValueByName(String, Object) - Method in interface com.veeva.vault.sdk.api.csv.RowBuilder
-
Sets a value on the row at the column specified by its name.
- split(String, String) - Static method in class com.veeva.vault.sdk.api.core.StringUtils
-
Splits the input String around matches of the given regular expression.
- split(String, String, int) - Static method in class com.veeva.vault.sdk.api.core.StringUtils
-
Splits the input String around matches of the given regular expression limit
number of times.
- streamResults() - Method in interface com.veeva.vault.sdk.api.query.QueryResponse
-
Streams the query results in the native query format,
QueryResult
.
- streamRows() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
Returns a
Stream
of all
Row
s in the CSV data.
- STRING - Static variable in interface com.veeva.vault.sdk.api.core.RequestContextValueType
-
- STRING - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
-
Maps to the "Text" field type in Vault.
- STRING - Static variable in interface com.veeva.vault.sdk.api.csv.CsvValueType
-
- STRING - Static variable in interface com.veeva.vault.sdk.api.http.HttpResponseBodyValueType
-
Plain text response body type.
- STRING - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
-
- STRING - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
-
Maps to the "Text" field type in Vault.
- StringUtils - Class in com.veeva.vault.sdk.api.core
-
A utility to access String pattern matching functionality.
- StringUtils() - Constructor for class com.veeva.vault.sdk.api.core.StringUtils
-
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.action.Usage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.EventSegment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.group.GroupType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.http.HttpMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.veeva.vault.sdk.api.action.Usage
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.EventSegment
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.csv.LineEnding
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.group.GroupType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.http.HttpMethod
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- ValueType<T> - Interface in com.veeva.vault.sdk.api.core
-
Type of data supported by the Vault Java SDK.
- VaultCollections - Class in com.veeva.vault.sdk.api.core
-
A utility to create JDK Collections and Arrays.
- VaultCollections() - Constructor for class com.veeva.vault.sdk.api.core.VaultCollections
-
- VaultCollectors - Class in com.veeva.vault.sdk.api.core
-
- VaultCollectors() - Constructor for class com.veeva.vault.sdk.api.core.VaultCollectors
-
- VaultRuntimeException - Exception in com.veeva.vault.sdk.api.core
-
Base runtime exception for exceptions that occur during execution.
- VaultRuntimeException() - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Constructs a new runtime exception with null
as its
detail message.
- VaultRuntimeException(String) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Constructs a new runtime exception with the specified detail message.
- VaultRuntimeException(String, Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Constructs a new runtime exception with the specified detail message and
cause.
- VaultRuntimeException(Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Constructs a new runtime exception with the specified cause and a
detail message of (cause==null ? null : cause.toString())
,
which typically contains the class and detail message of
cause
.