- cancel(WorkflowInstance, List<WorkflowTaskInstance>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskService
-
Cancels the given task instances.
- clear() - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Removes all values contained in the request context.
- 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.connection - package com.veeva.vault.sdk.api.connection
-
This package provides interfaces to create a Vault to Vault connection with a remote vault when using
DocumentService
.
- 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 Vault objects and create record triggers.
- 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.file - package com.veeva.vault.sdk.api.file
-
This package provides interfaces to retrieve file references from any vault
you can access, either in the current vault or a remote vault.
- 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.i18n - package com.veeva.vault.sdk.api.i18n
-
This package provides interfaces to read translated Messages in custom code.
- com.veeva.vault.sdk.api.integration - package com.veeva.vault.sdk.api.integration
-
This package provides interfaces to build Vault to Vault integrations which require data mapping.
- com.veeva.vault.sdk.api.job - package com.veeva.vault.sdk.api.job
-
This package provides interfaces to create job processors and 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.
- com.veeva.vault.sdk.api.workflow - package com.veeva.vault.sdk.api.workflow
-
This package provides interfaces to create custom actions for workflows and update entities within workflow processing.
- completeWithError(JobCompletionContext) - Method in interface com.veeva.vault.sdk.api.job.Job
-
Contains the logic to execute for a job which did not complete successfully.
- completeWithSuccess(JobCompletionContext) - Method in interface com.veeva.vault.sdk.api.job.Job
-
Contains the logic to execute for a job which completed successfully.
- ConfigurationContext - Interface in com.veeva.vault.sdk.api.action
-
Representation of the configuration details for an action, such as the usage context in which the action is configured
and executed against, and parameter values set by an Administrator in the object configuration for the action.
- ConnectionContext - Interface in com.veeva.vault.sdk.api.connection
-
Represents contextual information for the connection established with
ConnectionService
.
- ConnectionService - Interface in com.veeva.vault.sdk.api.connection
-
Provides methods to build a new connection context for use with
DocumentService
.
- ConnectionUser - Enum in com.veeva.vault.sdk.api.connection
-
Valid users to establish a connection to at least one vault.
- contains(String) - Method in interface com.veeva.vault.sdk.api.json.JsonObject
-
Determines if the specified attribute is present on the object.
- containsField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Given the field name, checks to see if an
ObjectField
exists with the name.
- convertToJson(Collection<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert from a Collection (List or Set) of UserDefinedModel objects into a JsonArray.
- convertToJson(U) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert from a UserDefinedModel instance into a JsonObject.
- convertToList(JsonArray, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a JsonArray into a List of UserDefinedModel objects.
- convertToList(String, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a String JsonArray into a List of UserDefinedModel objects.
- convertToSet(JsonArray, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a JsonArray into a Set of UserDefinedModel objects.
- convertToSet(String, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a String JsonArray into a Set of UserDefinedModel objects.
- convertToString(Collection<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert from a Collection (List or Set) of UserDefinedModel objects into a JsonArray String.
- convertToString(U) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert from a UserDefinedModel instance into a JsonObject String.
- convertToUserDefinedModel(JsonObject, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a JsonObject into a UserDefinedModel.
- convertToUserDefinedModel(String, Class<U>) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Convert a Json String into a UserDefinedModel.
- createAttachments(List<DocumentAttachment>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Creates new attachment- or attachment-versions for a document.
- createDocuments(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Creates new documents.
- createRenditions(List<DocumentRendition>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Creates new renditions for a document.
- CsvBuilder - Interface in com.veeva.vault.sdk.api.csv
-
- 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.
- 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.
- getAssigneeId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the user ID of the assignee.
- 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.
- getConnection() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the API name (api_name__sys
) of the Connection record referenced by this rule.
- getConnectionId() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequest
-
Retrieves the connection ID.
- 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.
- getCurrentTask() - Method in interface com.veeva.vault.sdk.api.job.JobProcessContext
-
Returns a JobTask
object for the current task, which contains task information.
- 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.
- getDocumentActionContext() - Method in interface com.veeva.vault.sdk.api.action.PostExecutionDocumentActionUIContext
-
Retrieve relevant contextual data for the document action.
- getDocumentActionContext() - Method in interface com.veeva.vault.sdk.api.action.PreExecutionDocumentActionUIContext
-
Retrieve relevant contextual data for the document action.
- 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
-
- 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.
- getDueDate() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the due date for the current task instance.
- 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.integration.FieldRuleResult
-
Returns field rule evaluation error.
- getError() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesResponse
-
Retrieves the error encountered when retrieving the integration rules, if any.
- getError() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
Retrieves errors about any issues encountered when putting the
Message
onto the queue.
- getErrorProvider() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the
ErrorProvider
instance associated with this Message.
- getErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationResponse
-
Returns the List of errors that occurred when processing the batch.
- getEvent() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the
WorkflowEvent
that occurred which caused this action to fire.
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
- getField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
- getField(ObjectFieldRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- getFieldCount() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Retrieves the number of entries in the collection.
- getFieldDefault() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
The static default value.
- getFieldRuleResults() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesResponse
-
Retrieves the result of evaluation of field rules of an integration rule.
- getFieldRules() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the list of the Fieldrules
sub-component under this Integrationrule
component.
- getFields(ObjectFieldCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- getFieldType() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
- getFilterClause() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves this QueryObjectRule
clause with any tokens unresolved.
- 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
.
- getGroups() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a List of groups contained in this participant group.
- 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
-
- getGroupsByNames(List<String>) - Method in interface com.veeva.vault.sdk.api.group.GroupService
-
- 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.
- getId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstance
-
Retrieves the ID of this workflow instance.
- getId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the ID of the current task instance.
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationError
-
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.PositionalResult
-
- getIntegrationPoint() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the API name (integration_point_api_name__sys
) of the Integration Point record
referenced by this rule.
- getIntegrationPointAPIName() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequest
-
Retrieves the integration point API name.
- getIntegrationRule() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the Integration rule contract object.
- getIntegrationRules() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesResponse
-
- getIntegrationRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
- getIntegrationRules(GetIntegrationRulesRequest) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Retrieves the list of IntegrationRules
corresponding to a Connection based on the
GetIntegrationRulesRequest
.
- getIntegrationRulesByIntegrationPoint(String, String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
- GetIntegrationRulesRequest - Interface in com.veeva.vault.sdk.api.integration
-
- GetIntegrationRulesRequestBuilder - Interface in com.veeva.vault.sdk.api.integration
-
- GetIntegrationRulesResponse - Interface in com.veeva.vault.sdk.api.integration
-
- getItems() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the input List of job items for a given task.
- getJobId() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the ID tracking this job.
- getJobId() - Method in interface com.veeva.vault.sdk.api.job.JobRunResult
-
Retrieves the job ID.
- getJobInitParameter(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobInitParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobLogger() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the job logger, used to log messages into the job log file.
- getJobName() - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
- getJobParameter(String, JobParamValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobResult() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
Retrieves the job status, from which you can retrieve the number of tasks which failed or succeeded.
- 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.data.ObjectField
-
Retrieves the label value, in the current user's language, of the given object field.
- getLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the label value, in the current user's language, of the given object.
- getLabel() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve the group label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves this FieldRule label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves this IntegrationRule
label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves this Queryobjectrule
label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
-
Retrieves a picklist value's label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowConfiguration
-
Retrieves the label of this workflow configuration.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves the label of this participant group.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskConfiguration
-
Returns the label of this task, as seen by task assignees.
- getLanguage() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the specified Vault-supported language code.
- getLanguages() - Method in interface com.veeva.vault.sdk.api.notification.TokenResolverInput
-
Retrieves a collection of language codes for the values the tokens
need to be resolved into.
- 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
.
- getLifecycleRoles() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a List of lifecycle roles contained in this participant group.
- 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.integration.FieldRuleError
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleError
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves this Message object.
- getMessage() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryError
-
Retrieves the message associated with the failed Spark message delivery.
- getMessageContext() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandlerContext
-
Retrieves the contextual information about a Message.
- getMessageDeliveryError() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandlerContext
-
Retrieves the failure type and error message of the failed Spark message delivery.
- getMessageGroup() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the specified Messagegroup name.
- 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
-
- getMessages() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the optional collection of Message names.
- 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.data.ObjectField
-
Retrieves the name of the given object field.
- getName() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the name of the given object.
- getName() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve the group name.
- getName() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieve the FieldRule name.
- getName() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves this IntegrationRule
name.
- getName() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves this Queryobjectrule
name.
- getName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowConfiguration
-
Retrieves the name of this workflow configuration.
- getName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves the name of this participant group.
- getNew() - Method in interface com.veeva.vault.sdk.api.data.RecordChange
-
Retrieves the new data for the Record.
- getNew() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskChange
-
The workflow task instance after event execution.
- getNumberCompletedTasks() - Method in interface com.veeva.vault.sdk.api.job.JobResult
-
Retrieves the number of completed tasks for this job.
- getNumberFailedTasks() - Method in interface com.veeva.vault.sdk.api.job.JobResult
-
Retrieves the number of failed tasks for this job.
- getNumberTasks() - Method in interface com.veeva.vault.sdk.api.job.JobResult
-
Retrieves the number of tasks in this job.
- getNumRows() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
Returns the total number of rows in the CSV data.
- getObject(ObjectMetadataRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- 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.
- getOld() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskChange
-
The workflow task instance prior to event execution.
- getParticipantGroup() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the
WorkflowParticipantGroup
this action is executing against, if the current event is executing
for the start step.
- getParticipantGroupLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskConfiguration
-
Retrieves the label of the participant group assigned to the task step.
- getParticipantGroupName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskConfiguration
-
Retrieves the participant group name assigned to the task step.
- getParticipantGroupNames() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowConfiguration
-
Retrieves the set of names for all the participant groups in this workflow configuration.
- getPicklist(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
Given a picklist
Name
, returns a
Picklist
object which can be used to retrieve
picklist information.
- getPicklist(PicklistRequest) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
- getPicklistValue(String) - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
Retrieves a
PicklistValue
object for a specific picklist value name.
- getPluralLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the plural label value, in the current user's language, of the given object.
- getPrimaryQueryObject() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the name of the primary query object of this integration rule.
- getPutMessageResults() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
- getQueryData() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the query data.
- getQueryDescribe() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the queryDescribe
JSON from the query response.
- getQueryField() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the mapped query field.
- getQueryFields(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves a Collection of query fields referenced in Fieldrules
for the specified query object.
- getQueryObject() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the mapped query object.
- getQueryObject() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves the name of the query object.
- getQueryObjectRules() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves all of the Queryobjectrules
for the Integrationrule
- getQueryObjectRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves any Queryobjectrules
which have the specified value for their object field.
- 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.
- getRecordActionContext() - Method in interface com.veeva.vault.sdk.api.action.PostExecutionRecordActionUIContext
-
Retrieve relevant contextual data for the record action.
- getRecordActionContext() - Method in interface com.veeva.vault.sdk.api.action.PreExecutionRecordActionUIContext
-
Retrieve relevant contextual data for the record action.
- 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
-
- 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
-
- 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.
- getRecords() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the object records this action is executing against.
- getReferenceLookup() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
The name of the reference lookup object.
- getReferenceLookupType() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
- 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.
- getResolvedFilterClause(Map<String, String>) - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves the resolved Queryobjectrule
filter clause for a given source object.
- 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.
- getRetryAttempt() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the task retry number.
- 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
-
- 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.
- getState() - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the task state for a specific state.
- getStatus() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the status of the current task instance.
- getStepType() - Method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
- 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.
- getTargetDocfield() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the reference to a document field, if target is a document.
- getTargetField() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Retrieves the target field name corresponding to this field rule evaluation.
- getTargetName() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the name of the target object from the Fieldrule
sub-component.
- getTargetObject() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the target Vault object.
- getTargetObjectField() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the target object field.
- getTaskChanges() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionTaskContext
-
Retrieves the changes for workflow task instances with the current task event, if the event is for
WorkflowStepType.TASK
.
- getTaskConfiguration() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionTaskContext
-
- getTaskContext() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
- getTaskId() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the task ID, such as "TASK1" or "TASK2".
- getTaskInstances(WorkflowInstance, WorkflowTaskQueryParameters) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskService
-
Retrieves task instances for a workflow instance.
- getTaskOutput() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the TaskOutput object which can be used to get or set the output parameters for a given task.
- getTasks() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
Retrieves the the list of tasks in this Job
.
- getTokenResolverOutput() - Method in interface com.veeva.vault.sdk.api.notification.TokenResolverInput
-
Retrieves a new TokenResolverOutput
object that can be used to
set the resolved token values for sending a notification.
- getTokens() - Method in interface com.veeva.vault.sdk.api.notification.TokenResolverInput
-
Retrieves a collection of token names to be resolved for values.
- getTranslations() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadResponse
-
Retrieves translations for the requested Messages.
- 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.
- getType() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleError
-
The item error type of the fieldrule.
- getType() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleError
-
The message error type of the integration rule.
- getType() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryError
-
Retrieves the error type of the failed Spark message delivery.
- 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
-
- 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
.
- getUsers() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a Set of user IDs contained in this participant group.
- 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() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Retrieves the value for the evaluated target field, already converted into the appropriate ValueType.
- getValue(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobItem
-
Retrieves the value of a job item parameter.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobItem
-
Retrieves the value of a job item parameter.
- getValue(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the value identified by the given name
from the task output.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the value identified by the given name
from the task output.
- 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.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the value of the specified attribute for this workflow.
- getValueByName(String, CsvValueType<T>) - Method in interface com.veeva.vault.sdk.api.csv.Row
-
Retrieves a value at a column specified by its name.
- getValueByType(ValueType<T>) - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Retrieves the value for the evaluated target field, converted to the type passed in.
- getValueType() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Retrieves the
ValueType
of the given object field.
- getWorkflowConfiguration() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
- getWorkflowInitiator() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstance
-
Retrieves the ID of the user who initiated this workflow instance.
- getWorkflowInstance() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the workflow instance this action is executing against, if the workflow instance exists.
- 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
-
- GroupType - Enum in com.veeva.vault.sdk.api.group
-
Valid values for group classifications.
- saveDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
- 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(HttpRequest, Class<U>) - 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
UserDefinedModel
type.
- 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
-
- setAttachmentVersion(int) - Method in interface com.veeva.vault.sdk.api.document.DocumentAttachmentFileReference
-
- 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
-
- setBody(U) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
- setBody(Collection<U>) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as the serialized form of the provided
UserDefinedModel
s.
- setBodyParam(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies a body param.
- setContentType(HttpRequestContentType) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies the Content-Type
header for this HTTP request.
- setError(String, String) - Method in interface com.veeva.vault.sdk.api.data.RecordChange
-
Sets an error on this Record change.
- setError(Record) - Method in interface com.veeva.vault.sdk.api.queue.ErrorProvider
-
Sets an error record to be stored in vault.
- 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.
- setGroups(List<Group>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupUpdate
-
Sets groups for the participant group, replacing any previous groups.
- 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.
- setJobInitParameter(String, Object) - Method in interface com.veeva.vault.sdk.api.job.JobInitContext
-
Sets the name and value of a job parameter.
- setJobRunTime(ZonedDateTime) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Sets the job start time.
- 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 Group
s 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 RecordRole
s 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.
- setSourceFile(FileReference) - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Sets the source file for the new document version when creating a
new document or a new version of an existing document.
- setState(TaskState) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Sets task state for a specific task.
- setStatuses(WorkflowTaskStatus...) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskQueryParameters
-
If specified, will filter the task instances by the given statuses.
- setSubject(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets the subject of a notification email.
- setTaskConfigurations(WorkflowTaskConfiguration...) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskQueryParameters
-
If specified, will filter the task instances by the given workflow task configurations.
- 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.
- setTokenResolver(Consumer<TokenResolverInput>) - Method in interface com.veeva.vault.sdk.api.notification.NotificationTemplate
-
Sets a Consumer that can provide resolved values for the requested tokens
specified in a TokenResolverInput
.
- 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.
- setTokenValues(String, Map<String, String>) - Method in interface com.veeva.vault.sdk.api.notification.TokenResolverOutput
-
Sets the resolved token values for a particular language.
- setUserActionUIBehavior(PostExecutionUserActionUIBehavior) - Method in interface com.veeva.vault.sdk.api.action.PostExecutionUIContext
-
Set post-execution UI behavior on the context.
- setUserActionUIBehavior(PreExecutionUserActionUIBehavior) - Method in interface com.veeva.vault.sdk.api.action.PreExecutionUIContext
-
Set pre-execution UI behavior on the context.
- setUsers(Set<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupUpdate
-
Sets users for the participant group, replacing any previous users.
- 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.JobItem
-
Sets the value of a job item parameter.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Sets the value of a job parameter.
- setValue(String, Object) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Sets the value of a task 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.
- setVersion(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentAttachment
-
Sets major and minor document version for the attachment.
- sleep(int) - Method in interface com.veeva.vault.sdk.api.core.RuntimeService
-
Puts the currently executing thread to sleep for the specified number of milliseconds, subject to governance
limits.
- 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.
- streamFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Streams the object fields in the native format,
ObjectField
.
- 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.job.JobParamValueType
-
Maps to the "Text" field type in Vault.
- STRING - Static variable in interface com.veeva.vault.sdk.api.job.JobValueType
-
Maps to the "Text" field type in Vault.
- 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
-
- suppressRendition() - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Disables generation of a viewable rendition from the source file for the
new document or document version.
- 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.connection.ConnectionUser
-
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.core.UserDefinedPropertyInclude
-
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.ObjectFieldType
-
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.http.HttpRequestContentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.ItemErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.MessageErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.job.TaskState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
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.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
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.connection.ConnectionUser
-
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.core.UserDefinedPropertyInclude
-
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.ObjectFieldType
-
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.http.HttpRequestContentType
-
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.integration.ItemErrorType
-
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.integration.MessageErrorType
-
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.integration.ReferenceLookupType
-
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.job.TaskState
-
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.queue.MessageDeliveryErrorType
-
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.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
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.workflow.WorkflowStepType
-
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.workflow.WorkflowTaskStatus
-
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
-
- VaultRuntimeException() - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with null
as its
detail message.
- VaultRuntimeException(String) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with the specified detail message.
- VaultRuntimeException(String, Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with the specified detail message and
cause.
- VaultRuntimeException(Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
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
.