Skip navigation links
A B C D E G H I J L M N O P Q R S T U V 

A

add(Object) - Method in interface com.veeva.vault.sdk.api.json.JsonArrayBuilder
Adds a value to the end of the building array.
addGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleUpdate
Adds groups to a role.
addGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleUpdate
Adds groups to a role.
addRow(Row) - Method in interface com.veeva.vault.sdk.api.csv.CsvBuilder
Adds a row of values to the CSV data.
addRow(List<Object>) - Method in interface com.veeva.vault.sdk.api.csv.CsvBuilder
Adds a row of values to the CSV data.
addUsers(List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleUpdate
Adds users to a role.
addUsers(List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleUpdate
Adds users to a role.
appendPath(String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
Appends the given path to the base URL.
appendPath(String, String) - Method in interface com.veeva.vault.sdk.api.queue.Message
Appends a path to a specific connection's base URL for this Message.
ARRAY - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
 
asList(T...) - Static method in class com.veeva.vault.sdk.api.core.VaultCollections
Creates and returns a fixed-size List backed by the specified array.
asString() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
Returns the CSV as a String.
asString() - Method in interface com.veeva.vault.sdk.api.csv.Row
Returns the row as a String.
asString() - Method in interface com.veeva.vault.sdk.api.json.JsonArray
Formats the array as a String.
asString() - Method in interface com.veeva.vault.sdk.api.json.JsonObject
Formats the object as a String.

B

batchAssignMissingUsers(List<DocumentVersion>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
Creates an operation which can be used to update document roles such that all of the given user IDs are on the given document lifecycle role on all of the given documents.
batchAssignMissingUsers(List<Record>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
Creates an operation which can be used to update record roles such that all of the given user IDs are on the given record role on all of the given records.
batchDeleteRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
Creates an operation which can be used to delete the specified List of Records.
BatchOperation<S,E> - Interface in com.veeva.vault.sdk.api.core
A sequence of instructions that can be chained together, building up a final operation which can be executed with BatchOperation.execute().
BatchOperationError - Interface in com.veeva.vault.sdk.api.core
Retrieves batch operation errors for a particular input List position.
BatchOperationResponse<R extends PositionalResult> - Interface in com.veeva.vault.sdk.api.core
Base interface to be used as a response to batch operations.
batchSaveRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
Creates an operation to save the specified List of records.
batchUpdateDocumentRoles(List<DocumentRoleUpdate>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
Creates an operation which can be used to update document roles.
batchUpdateRecordRoles(List<RecordRoleUpdate>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
Adds or removes users and groups from this RecordRole.
BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.core.RequestContextValueType
 
BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
Maps to the "Yes/No" field type in Vault.
BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.csv.CsvValueType
 
BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
 
BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
Maps to the "Yes/No" field type in Vault.
build() - Method in interface com.veeva.vault.sdk.api.csv.CsvBuilder
Builds and returns the CSV data.
build() - Method in interface com.veeva.vault.sdk.api.csv.RowBuilder
Builds and returns the row.
build() - Method in interface com.veeva.vault.sdk.api.json.JsonArrayBuilder
Returns the built JsonArray.
build() - Method in interface com.veeva.vault.sdk.api.json.JsonObjectBuilder
Returns a built JsonObject.

C

com.veeva.vault.sdk.api.action - package com.veeva.vault.sdk.api.action
This package provides interfaces to create custom actions.
com.veeva.vault.sdk.api.core - package com.veeva.vault.sdk.api.core
This package provides interfaces for common functions and utilities, such as the Debug Log and request context.
com.veeva.vault.sdk.api.csv - package com.veeva.vault.sdk.api.csv
This package provides interfaces to manage reading and writing CSV data.
com.veeva.vault.sdk.api.data - package com.veeva.vault.sdk.api.data
This package provides interfaces to manage object records.
com.veeva.vault.sdk.api.document - package com.veeva.vault.sdk.api.document
This package provides interfaces to manage documents and binders.
com.veeva.vault.sdk.api.group - package com.veeva.vault.sdk.api.group
This package provides interfaces to retrieve group membership information.
com.veeva.vault.sdk.api.http - package com.veeva.vault.sdk.api.http
This package provides interfaces to make HTTP callouts (to Vault or to an external service).
com.veeva.vault.sdk.api.job - package com.veeva.vault.sdk.api.job
This package provides interfaces to execute asynchronous jobs.
com.veeva.vault.sdk.api.json - package com.veeva.vault.sdk.api.json
This package provides interfaces to manage reading and writing JSON data.
com.veeva.vault.sdk.api.notification - package com.veeva.vault.sdk.api.notification
This package provides interfaces to send Vault notifications.
com.veeva.vault.sdk.api.picklist - package com.veeva.vault.sdk.api.picklist
This package provides interfaces to retrieve picklist information.
com.veeva.vault.sdk.api.query - package com.veeva.vault.sdk.api.query
This package provides interfaces to execute queries and retrieve data from query responses.
com.veeva.vault.sdk.api.queue - package com.veeva.vault.sdk.api.queue
This package provides interfaces to send and receive Spark messages.
com.veeva.vault.sdk.api.role - package com.veeva.vault.sdk.api.role
This package provides interfaces to retrieve and manage role membership for a document or object record.
ConfigurationContext - Interface in com.veeva.vault.sdk.api.action
Not Yet Available.
contains(String) - Method in interface com.veeva.vault.sdk.api.json.JsonObject
Determines if the specified attribute is present on the object.
CsvBuilder - Interface in com.veeva.vault.sdk.api.csv
Builds CsvData.
CsvData - Interface in com.veeva.vault.sdk.api.csv
Represents immutable CSV data.
CSVDATA - Static variable in interface com.veeva.vault.sdk.api.http.HttpResponseBodyValueType
CSV response body type.
CsvHeaders - Interface in com.veeva.vault.sdk.api.csv
The headers (column names) for CSV data.
CsvReadParameters - Interface in com.veeva.vault.sdk.api.csv
Parameters that define the format of the CSV being read.
CsvService - Interface in com.veeva.vault.sdk.api.csv
Service for reading and writing CSV data.
CsvValueType<T> - Interface in com.veeva.vault.sdk.api.csv
Types that can be read from or written to CSV data.
CsvWriteParameters - Interface in com.veeva.vault.sdk.api.csv
Parameters that define the format of the CSV being written.

D

DATE - Static variable in interface com.veeva.vault.sdk.api.core.RequestContextValueType
 
DATE - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
Maps to the "Date" field type in Vault.
DATE - Static variable in interface com.veeva.vault.sdk.api.csv.CsvValueType
 
DATE - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
Maps to the "Date" field type in Vault.
DATETIME - Static variable in interface com.veeva.vault.sdk.api.core.RequestContextValueType
 
DATETIME - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
Maps to the "DateTime" field type in Vault.
DATETIME - Static variable in interface com.veeva.vault.sdk.api.csv.CsvValueType
 
DATETIME - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
Maps to the "DateTime" field type in Vault.
debug(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs a DEBUG type message to the Debug Log.
debug(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs the templated DEBUG type message to the Debug Log.
debug(Supplier<String>) - Method in interface com.veeva.vault.sdk.api.core.LogService
Output the String returned from a single call to messageSupplier.get() to the Debug Log.
deleteDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
Delete the specified List of DocumentVersions.
DeleteDocumentVersionsResponse - Interface in com.veeva.vault.sdk.api.document
Response from a call to DocumentService.deleteDocumentVersions(List) (List)}.
deleteRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
Deprecated.
as of 17R2.2, replaced by RecordService.batchDeleteRecords(List)
DeleteRecordsResponse - Interface in com.veeva.vault.sdk.api.data
Deprecated.
DocumentAction - Interface in com.veeva.vault.sdk.api.action
Executes a given document action; takes DocumentActionContext as input.
DocumentActionContext - Interface in com.veeva.vault.sdk.api.action
Contains contextual data about a document action during execution.
DocumentActionInfo - Annotation Type in com.veeva.vault.sdk.api.action
Indicates a class is a document action.
DocumentRole - Interface in com.veeva.vault.sdk.api.role
Provides methods to retrieve information in a DocumentRole.
DocumentRoleService - Interface in com.veeva.vault.sdk.api.role
Provides methods to read and update DocumentRoles.
DocumentRoleUpdate - Interface in com.veeva.vault.sdk.api.role
Provides methods to add or remove users and groups in a DocumentRole.
DocumentService - Interface in com.veeva.vault.sdk.api.document
Provides methods to update and delete documents.
DocumentVersion - Interface in com.veeva.vault.sdk.api.document
Represents a document version.

E

error(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs an ERROR type message to the Debug Log.
error(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs the templated ERROR type message to the Debug Log.
error(Supplier<String>) - Method in interface com.veeva.vault.sdk.api.core.LogService
Output the String returned from a single call to messageSupplier.get() to the Debug Log.
ErrorResult - Interface in com.veeva.vault.sdk.api.core
Represents an error.
escape(String) - Method in interface com.veeva.vault.sdk.api.query.QueryService
Escapes special characters in a string for use in a VQL statement.
EventSegment - Enum in com.veeva.vault.sdk.api.core
For internal Veeva use only.
execute(DocumentActionContext) - Method in interface com.veeva.vault.sdk.api.action.DocumentAction
The logic to execute when the action is invoked.
execute(RecordActionContext) - Method in interface com.veeva.vault.sdk.api.action.RecordAction
The logic to execute when the action is invoked.
execute() - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
Executes the batch operation.
execute(RecordTriggerContext) - Method in interface com.veeva.vault.sdk.api.data.RecordTrigger
Invoked to start a trigger.
execute() - Method in interface com.veeva.vault.sdk.api.http.HttpOperation
Executes the HTTP operation.
execute(MessageContext) - Method in interface com.veeva.vault.sdk.api.queue.MessageProcessor
Message processing logic is implemented inside this method.
execute(RecordRoleTriggerContext) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTrigger
Invoked when a record role trigger executes.

G

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
Retrieves an attribute set by Message.setAttribute(String, Object).
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
Retrieves a DocumentRole for a given document.
getDocumentRoles(List<DocumentVersion>, String) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
Retrieves a GetDocumentRolesResponse object, which can be used to retrieve any manually assigned DocumentRoles for a given document.
GetDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
Provides methods to retrieve DocumentRole, returned from DocumentRoleService.getDocumentRoles(List, String).
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
For the given group, returns a GetGroupInDocumentRolesResponse which can be used to check if the group is in a particular document role.
GetGroupInDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
Provides methods to check if a particular group is assigned to a given document role, returned from DocumentRoleService.getGroupInDocumentRoles(Group, List).
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
Provides methods to check group membership in a RecordRole, returned from RecordRoleService.getGroupInRecordRoles(Group, List).
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
Returns the CsvHeaders for the data, if present.
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
Get the name of the job specified in a JobParameters object.
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 lifecycle role label, for example, Approver.
getLifecycleRoleName() - Method in interface com.veeva.vault.sdk.api.role.LifecycleRole
Retrieves the 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
Retrieves an immutable List of String items set by Message.getMessageItems().
getMissingAssignments(List<DocumentVersion>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
Retrieves a GetMissingAssignmentsDocumentResponse which can be used to check for an incompleteness of document roles.
getMissingAssignments(List<Record>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
Retrieves a GetMissingAssignmentsRecordResponse which can be used to check for an incompleteness of record roles.
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
Retrieves a RecordRole for a given record.
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
Deprecated.
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
Provides methods to retrieve RecordRoles, returned from RecordRoleService.getRecordRoles(List, String).
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 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
For a given userId, retrieves a GetUserInDocumentRolesResponse which can be used to check if the user is in a particular document role.
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.

H

hasErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationResponse
Returns whether or not there was at least one error encountered while processing the batch.
HttpMethod - Enum in com.veeva.vault.sdk.api.http
Valid values for HTTP methods.
HttpOperation<T> - Interface in com.veeva.vault.sdk.api.http
A sequence of instructions that can be chained together, building up a final operation which can be executed with HttpOperation.execute().
HttpOperationError - Interface in com.veeva.vault.sdk.api.http
Represents an HTTP operation error.
HttpOperationErrorType - Enum in com.veeva.vault.sdk.api.http
Valid values for errors on HTTP request execution.
HttpRequest - Interface in com.veeva.vault.sdk.api.http
Represents an HTTP request.
HttpResponse<T> - Interface in com.veeva.vault.sdk.api.http
Represents an HTTP request execution response.
HttpResponseBodyValueType<T> - Interface in com.veeva.vault.sdk.api.http
Types of data supported by an HTTP response body.
HttpService - Interface in com.veeva.vault.sdk.api.http
Provides methods to make HTTP requests.

I

ignoreError() - Method in interface com.veeva.vault.sdk.api.http.HttpOperation
When specified, any error specified by HttpOperationErrorType is ignored during HTTP request execution.
ignoreErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
Indicates errors are ignored during execution.
info(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs an INFO type message to the Debug Log.
info(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
Outputs the templated INFO type message to the Debug Log.
info(Supplier<String>) - Method in interface com.veeva.vault.sdk.api.core.LogService
Output the String returned from a single call to messageSupplier.get() to the Debug Log.
isActive() - Method in interface com.veeva.vault.sdk.api.group.Group
Check if a group is active.
isActive() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
Determine if a picklist value is active or inactive.
isDebugEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
 
isErrorEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
 
isExecutable(DocumentActionContext) - Method in interface com.veeva.vault.sdk.api.action.DocumentAction
Determines if an action is available to users for execution.
isExecutable(RecordActionContext) - Method in interface com.veeva.vault.sdk.api.action.RecordAction
Determines if an action is available to users for execution.
isGroupInDocumentRole(DocumentRole) - Method in interface com.veeva.vault.sdk.api.role.GetGroupInDocumentRolesResponse
Checks if a particular group is assigned to the given document role.
isGroupInRecordRole(RecordRole) - Method in interface com.veeva.vault.sdk.api.role.GetGroupInRecordRolesResponse
Checks if the Group is in a role on a record.
isInfoEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
 
isOriginatedInThisProcess() - Method in exception com.veeva.vault.sdk.api.core.VaultRuntimeException
 
isUserInDocumentRole(DocumentRole) - Method in interface com.veeva.vault.sdk.api.role.GetUserInDocumentRolesResponse
Checks if a particular user is assigned to the given document role.
isUserInGroup(String, Group) - Method in interface com.veeva.vault.sdk.api.group.GroupService
Check if a user belongs to a group.
isUserInRecordRole(RecordRole) - Method in interface com.veeva.vault.sdk.api.role.GetUserInRecordRolesResponse
Checks if the user is in a role on a record.
isValidJson() - Method in interface com.veeva.vault.sdk.api.json.JsonData
Determines if the JSON is valid.

J

JobParameters - Interface in com.veeva.vault.sdk.api.job
Methods to set values for job parameters.
JobService - Interface in com.veeva.vault.sdk.api.job
Service interface to run jobs with specified parameters.
JsonArray - Interface in com.veeva.vault.sdk.api.json
Represents a JSON array.
JsonArrayBuilder - Interface in com.veeva.vault.sdk.api.json
Builds JsonArray instances.
JSONDATA - Static variable in interface com.veeva.vault.sdk.api.http.HttpResponseBodyValueType
JSON response body type.
JsonData - Interface in com.veeva.vault.sdk.api.json
Represents immutable JSON.
JsonObject - Interface in com.veeva.vault.sdk.api.json
Represents a JSON object.
JsonObjectBuilder - Interface in com.veeva.vault.sdk.api.json
Builds JsonObject instances.
JsonService - Interface in com.veeva.vault.sdk.api.json
Service for reading and writing JSON data.
JsonValueType<T> - Interface in com.veeva.vault.sdk.api.json
Types that can be read from or written to JSON data.

L

LifecycleRole - Interface in com.veeva.vault.sdk.api.role
Provides methods to retrieve role information for a document or object lifecycle.
LineEnding - Enum in com.veeva.vault.sdk.api.csv
Line endings supported while reading/writing CSVs.
locate(Class<T>) - Static method in class com.veeva.vault.sdk.api.core.ServiceLocator
Locates the requested Service.
LogService - Interface in com.veeva.vault.sdk.api.core
Send messages to the Debug Log, available in Admin > Logs > Debug Log.

M

matches(String, String) - Static method in class com.veeva.vault.sdk.api.core.StringUtils
Whether or not the input String matches the given regular expression.
Message - Interface in com.veeva.vault.sdk.api.queue
Provides methods to update the content of a Spark message.
MessageAttributeValueType<T> - Interface in com.veeva.vault.sdk.api.queue
Type of data supported by the Vault Java SDK.
MessageContext - Interface in com.veeva.vault.sdk.api.queue
Contains contextual information about a Message.
MessageProcessor - Interface in com.veeva.vault.sdk.api.queue
Invoked to process a message received by an inbound queue.
MessageProcessorInfo - Annotation Type in com.veeva.vault.sdk.api.queue
Indicates a class is a MessageProcessor.

N

newCsvBuilder() - Method in interface com.veeva.vault.sdk.api.csv.CsvService
Returns a new CsvBuilder.
newCsvBuilder(CsvWriteParameters) - Method in interface com.veeva.vault.sdk.api.csv.CsvService
Returns a new CsvBuilder.
newCsvReadParameters() - Method in interface com.veeva.vault.sdk.api.csv.CsvService
Returns a new instance of CsvReadParameters that has the default parameter values.
newCsvWriteParameters() - Method in interface com.veeva.vault.sdk.api.csv.CsvService
Returns a new instance of CsvWriteParameters that has the default parameter values.
newDocumentRoleUpdate(String, DocumentVersion) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
Creates a DocumentRoleUpdate which can be submitted to DocumentRoleService.batchUpdateDocumentRoles(List) to update document roles on a particular document.
newDocumentVersion(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
Instantiates a DocumentVersion and sets the id, major version, and minor version.
newDocumentWithId(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
Instantiates a DocumentVersion with the given id and sets the version to the latest version of the document.
newHttpRequest(String) - Method in interface com.veeva.vault.sdk.api.http.HttpService
Create a new HTTP request corresponding to the given connectionName (local, vault-to-vault, or external connection).
newJobParameters(String) - Method in interface com.veeva.vault.sdk.api.job.JobService
Get a new JobParameters object for a specific job to set the parameters of the job.
newJsonArrayBuilder() - Method in interface com.veeva.vault.sdk.api.json.JsonService
Returns a new JsonArrayBuilder.
newJsonObjectBuilder() - Method in interface com.veeva.vault.sdk.api.json.JsonService
Returns a new JsonObjectBuilder.
newList() - Static method in class com.veeva.vault.sdk.api.core.VaultCollections
Constructs and returns an empty List, which may contain up to 10,000 items.
newLocalHttpRequest() - Method in interface com.veeva.vault.sdk.api.http.HttpService
Create a new HTTP request to represent a connection to the current vault as the current user.
newMap() - Static method in class com.veeva.vault.sdk.api.core.VaultCollections
Constructs and returns an empty Map, which may contain up to 10,000 items.
newMessage(String) - Method in interface com.veeva.vault.sdk.api.queue.QueueService
Creates a new instance of a Message to be sent on a queue with QueueService.putMessage(Message), in order to set message attributes and items.
newNotificationMessage() - Method in interface com.veeva.vault.sdk.api.notification.NotificationService
Creates a new NotificationMessage object to set subject, message, notification text and tokens to use in a notification.
newNotificationParameters() - Method in interface com.veeva.vault.sdk.api.notification.NotificationService
Creates a new NotificationParameters object to set the parameters of the notification.
newNotificationTemplate() - Method in interface com.veeva.vault.sdk.api.notification.NotificationService
Creates a new NotificationTemplate object to set the template to use and tokens to resolve for a notification.
newRecord(String) - Method in interface com.veeva.vault.sdk.api.data.RecordService
Instantiates a Record of the specified type but does not set the id.
newRecordRoleUpdate(String, Record) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
Updates RecordRoleUpdate.
newRecordWithId(String, String) - Method in interface com.veeva.vault.sdk.api.data.RecordService
Instantiates a Record of the specified type and sets the id.
newRowBuilder(CsvBuilder) - Method in interface com.veeva.vault.sdk.api.csv.CsvService
Returns a new RowBuilder that can be used to build rows for the specified CsvBuilder.
newSet() - Static method in class com.veeva.vault.sdk.api.core.VaultCollections
Constructs and returns an empty Set, which may contain up to 10,000 items.
NO_ESCAPE_CHARACTER - Static variable in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
Character that can be provided to CsvReadParameters.setEscape(char) if occurrences of the default escape character ('\') should be treated as the literal character, and not as a marker for the start of an escaped character.
NO_ESCAPE_CHARACTER - Static variable in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
Character that can be provided to CsvWriteParameters.setEscape(char) if no escapes should be written before individual values.
NO_QUOTES_CHARACTER - Static variable in interface com.veeva.vault.sdk.api.csv.CsvReadParameters
Character that can be provided to CsvReadParameters.setQuote(char) if occurrences of the default quote character ('"') should be treated as the literal character, and not as a marker for the start/end of an individual value.
NO_QUOTES_CHARACTER - Static variable in interface com.veeva.vault.sdk.api.csv.CsvWriteParameters
Character that can be passed into CsvWriteParameters.setQuote(char) if no quotes should be written around individual values.
NotificationMessage - Interface in com.veeva.vault.sdk.api.notification
Set the subject, message, and text to use in a notification.
NotificationParameters - Interface in com.veeva.vault.sdk.api.notification
Set the recipients, sender, and other notification options.
NotificationService - Interface in com.veeva.vault.sdk.api.notification
Send Vault notifications.
NotificationTemplate - Interface in com.veeva.vault.sdk.api.notification
Set the template and tokens to resolve for a notification.
NUMBER - Static variable in interface com.veeva.vault.sdk.api.core.RequestContextValueType
 
NUMBER - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
Maps to the "Number" field type in Vault.
NUMBER - Static variable in interface com.veeva.vault.sdk.api.csv.CsvValueType
 
NUMBER - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
 
NUMBER - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
Maps to the "Number" field type in Vault.

O

OBJECT - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
 
onError(Consumer<HttpOperationError>) - Method in interface com.veeva.vault.sdk.api.http.HttpOperation
A function called when an HTTP request execution has failed with one of the HttpOperationErrorType errors.
onErrors(Consumer<List<E>>) - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
A function called during execution if there is at least one error in the batch.
onSuccess(Consumer<HttpResponse<T>>) - Method in interface com.veeva.vault.sdk.api.http.HttpOperation
A function called when HTTP request execution has completed successfully with an HTTP response status code of 200.
onSuccesses(Consumer<List<S>>) - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
A function called during execution if there is at least one success in the batch.

P

Picklist - Interface in com.veeva.vault.sdk.api.picklist
This interface provides information about a picklist.
PICKLIST_VALUES - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
Represents a list of names (type List<String>) of picklist values.
PicklistService - Interface in com.veeva.vault.sdk.api.picklist
Service to retrieve picklist information.
PicklistValue - Interface in com.veeva.vault.sdk.api.picklist
This interface provides access to picklist values to retrieve picklist labels and determine if a picklist value is active.
PositionalDocumentVersionId - Interface in com.veeva.vault.sdk.api.document
Represents a successful result of processing a document in a batch operation, such as a save or delete.
PositionalRecordId - Interface in com.veeva.vault.sdk.api.data
Represents a successful result of processing a record in a batch operation.
PositionalResult - Interface in com.veeva.vault.sdk.api.core
Represents the result of processing an input item in a batch operation.
putMessage(Message) - Method in interface com.veeva.vault.sdk.api.queue.QueueService
Puts a Message onto a queue specified by QueueService.newMessage(String).
PutMessageResponse - Interface in com.veeva.vault.sdk.api.queue
The response returned by QueueService.putMessage(Message).
PutMessageResult - Interface in com.veeva.vault.sdk.api.queue
Represents the result for a specific connection during QueueService.putMessage(Message).

Q

query(String) - Method in interface com.veeva.vault.sdk.api.query.QueryService
Executes the given vqlQuery.
QueryResponse - Interface in com.veeva.vault.sdk.api.query
Represents the result of a query execution.
QueryResult - Interface in com.veeva.vault.sdk.api.query
Represents a single row in QueryResponse.
QueryService - Interface in com.veeva.vault.sdk.api.query
Service to execute VQL queries.
QueueService - Interface in com.veeva.vault.sdk.api.queue
Provides methods to create and put messages in a queue.

R

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
Response from a call to RecordService.readRecords(List).
Record - Interface in com.veeva.vault.sdk.api.data
Represents a Vault object record.
RecordAction - Interface in com.veeva.vault.sdk.api.action
Executes a given record action; takes RecordActionContext as input.
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 RecordRoles.
RecordRoleTrigger - Interface in com.veeva.vault.sdk.api.role
Invoked to start a trigger; takes RecordRoleTriggerContext as input.
RecordRoleTriggerContext - Interface in com.veeva.vault.sdk.api.role
Input to a RecordRoleTrigger.
RecordRoleTriggerInfo - Annotation Type in com.veeva.vault.sdk.api.role
Indicates a class is a RecordRoleTrigger.
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
Invoked to start a trigger; takes RecordTriggerContext as input.
RecordTriggerContext - Interface in com.veeva.vault.sdk.api.data
Input to a RecordTrigger.
RecordTriggerInfo - Annotation Type in com.veeva.vault.sdk.api.data
Indicates a class is a RecordTrigger.
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
Builds CSV Rows.
run(JobParameters) - Method in interface com.veeva.vault.sdk.api.job.JobService
Run a job as specified in a JobParameters object.

S

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
Deprecated.
as of 17R2.2, replaced by RecordService.batchSaveRecords(List)
SaveRecordsResponse - Interface in com.veeva.vault.sdk.api.data
Deprecated.
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
Specifies request body as CSV as returned by CsvData.asString().
setBody(JsonObject) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
Specifies request body as JSON as returned by JsonObject.asString().
setBody(JsonArray) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
Specifies request body as JSON as returned by JsonArray.asString().
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 Rows 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
 

T

toList() - Static method in class com.veeva.vault.sdk.api.core.VaultCollectors
Returns a Collector that accumulates the input elements into a new List.
toMap(Function<? super T, ? extends K>, Function<? super T, ? extends U>) - Static method in class com.veeva.vault.sdk.api.core.VaultCollectors
Returns a Collector that accumulates elements into a Map whose keys and values are the result of applying the provided mapping functions to the input elements.
toMap(Function<? super T, ? extends K>, Function<? super T, ? extends U>, BinaryOperator<U>) - Static method in class com.veeva.vault.sdk.api.core.VaultCollectors
Returns a Collector that accumulates elements into a Map whose keys and values are the result of applying the provided mapping functions to the input elements.
toSet() - Static method in class com.veeva.vault.sdk.api.core.VaultCollectors
Returns a Collector that accumulates the input elements into a new Set.
TriggerOrder - Enum in com.veeva.vault.sdk.api.core
Contains valid values for specifying trigger execution order.

U

Usage - Enum in com.veeva.vault.sdk.api.action
Where in Vault the action is available for configuration and execution.
UserDefinedClassInfo - Annotation Type in com.veeva.vault.sdk.api.core
Indicates a class is a user-defined class (UDC).

V

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
A utility to create Collector.
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.
A B C D E G H I J L M N O P Q R S T U V 
Skip navigation links

Copyright © Veeva Systems 2017–2019. All rights reserved.