Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ActionErrorType - Enum Class in com.veeva.vault.sdk.api.lifecycle
-
Error types that can occur during SDK action execution.
- add(Object) - Method in interface com.veeva.vault.sdk.api.json.JsonArrayBuilder
-
Adds a value to the end of the building array.
- ADD_PARTICIPANTS - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Adds participants to an active workflow.
- 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.
- addParticipants(WorkflowAddParticipantsRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowAddParticipantsOperation
, which can be used to add participants to an active workflow based on the providedWorkflowAddParticipantsRequest
. - 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.
- adminConfigurable() - Element in annotation interface com.veeva.vault.sdk.api.job.JobInfo
-
Determines if the job processor is available to be called with custom SDK code or by configuration by an Admin as a Job Definition in the Vault UI.
- AFTER - Enum constant in enum class com.veeva.vault.sdk.api.core.EventPosition
- AFTER - Enum constant in enum class com.veeva.vault.sdk.api.role.RecordRoleEvent
-
The trigger executes after the RecordRole change, whether it is adding or removing a role.
- AFTER_CREATE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately after the workflow instance is created, which is directly after the GET_PARTICIPANTS event.
- AFTER_DELETE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- AFTER_INSERT - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- AFTER_UPDATE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- aliases() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedProperty
-
Additional aliases to deserialize to this user-defined property.
- allowedSenders() - Element in annotation interface com.veeva.vault.sdk.api.email.EmailProcessorInfo
-
Indicates the types of senders this email processor can receive emails from.
- allowInlineCreate() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves whether the document reference field allows inline create.
- allowInlineCreate() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves whether the parent reference field allows inline create.
- allowInlineCreate() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves whether the reference field allows inline create.
- allowRelationshipDeepCopy() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve whether the parent reference field allows relationship deep copy.
- allowsReplies() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationType
-
Returns whether this annotation type allows replies.
- ALLVERSIONS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryTargetOption
-
Indicates all matching versions should be returned.
- ALWAYS - Enum constant in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Specifies this field is always included in the JSON.
- AND - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Logical
AND
between two boolean expressions. - Annotation - Interface in com.veeva.vault.sdk.api.annotation
-
Represents a document annotation.
- ANNOTATION_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorType
-
Represents an error that occurred because a specified annotation cannot be found, or because the user does not have permission to view it.
- ANNOTATION_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error that occurred because a specified annotation cannot be found, or because the user does not have permission to view it.
- ANNOTATION_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationReadErrorType
-
The specified annotation cannot be found, or the user does not have permission to view it.
- Annotation.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
Annotation
. - AnnotationBatchDeleteError - Interface in com.veeva.vault.sdk.api.annotation
-
Represents a positional error result for batch delete operations calls from
AnnotationService
, indicating that one of the inputs in the batch failed. - AnnotationBatchDeleteErrorResult - Interface in com.veeva.vault.sdk.api.annotation
-
Provides data about an error included in the response of batch delete operations provided by
AnnotationService
, including the error message and type. - AnnotationBatchDeleteErrorType - Enum Class in com.veeva.vault.sdk.api.annotation
-
Represents the error types included in the response of batch delete operations provided by
AnnotationService
when a particular input fails with an error. - AnnotationBatchDeleteRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Represents a request to delete multiple annotations by providing a
List
of annotation IDs. - AnnotationBatchDeleteRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationBatchDeleteRequest
. - AnnotationBatchSaveError - Interface in com.veeva.vault.sdk.api.annotation
-
Represents a positional error result for batch save operations calls from
AnnotationService
, indicating that one of the inputs in the batch failed. - AnnotationBatchSaveErrorResult - Interface in com.veeva.vault.sdk.api.annotation
-
Provides data about an error included in the response of batch save operations provided by
AnnotationService
, including the error message and type. - AnnotationBatchSaveErrorType - Enum Class in com.veeva.vault.sdk.api.annotation
-
Represents error types included in the response of batch save operations provided by
AnnotationService
when a particular input fails with an error. - AnnotationBatchSaveRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Represents a request to create or update multiple annotations by providing a
List
ofAnnotation
s. - AnnotationBatchSaveRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationBatchSaveRequest
. - AnnotationBatchSaveSuccess - Interface in com.veeva.vault.sdk.api.annotation
-
Represents the result of processing an
AnnotationService.batchSaveAnnotations(AnnotationBatchSaveRequest)
, indicating that one of theAnnotation
s passed in the batch successfully created at least one resulting annotation. - AnnotationField - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation field.
- AnnotationFieldRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve the metadata of an
AnnotationField
. - AnnotationFieldRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationFieldRequest
. - AnnotationMetadataService - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve metadata about annotation types, annotation fields, placemark types, placemark fields, reference types, and reference fields.
- AnnotationPlacemark - Interface in com.veeva.vault.sdk.api.annotation
-
Represents an annotation placemark and provides methods to retrieve field values and type names for any annotation placemark type.
- AnnotationPlacemark.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationPlacemark
. - AnnotationPlacemarkField - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation placemark field.
- AnnotationPlacemarkFieldRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Retrieves an instance of
AnnotationPlacemarkField
to build the request for retrieving annotation placemark field metadata. - AnnotationPlacemarkFieldRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationPlacemarkFieldRequest
. - AnnotationPlacemarkType - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation placemark type.
- AnnotationPlacemarkTypeRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Retrieves an instance of
AnnotationPlacemarkType
to build the request for retrieving annotation placemark type metadata. - AnnotationPlacemarkTypeRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationPlacemarkTypeRequest
. - AnnotationPlacemarkValueSetRequest<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the value set of an
AnnotationPlacemarkField
on a particularAnnotationPlacemarkType
. - AnnotationPlacemarkValueSetRequest.Builder<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationPlacemarkValueSetRequest
. - AnnotationPlacemarkValueType<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Types of data supported by
AnnotationPlacemark
s. - AnnotationReadErrorResult - Interface in com.veeva.vault.sdk.api.annotation
-
Represents an error included in the response of read operations provided by
AnnotationService
. - AnnotationReadErrorType - Enum Class in com.veeva.vault.sdk.api.annotation
-
Error types that may occur during read operations provided by
AnnotationService
when a request fails with an error. - AnnotationReadOperation - Interface in com.veeva.vault.sdk.api.annotation
-
A sequence of instructions that can be chained together to read annotations, building up to a final operation that can be executed with
AnnotationReadOperation.execute()
. - AnnotationReadRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Requests to read multiple annotations by providing either a
List
of unique annotation IDs or a document version ID to read annotations from. - AnnotationReadRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
A builder for an
AnnotationReadRequest
, including filters on the request. - AnnotationReadResponse - Interface in com.veeva.vault.sdk.api.annotation
-
Response from a call to
AnnotationService.readAnnotations(AnnotationReadRequest)
. - AnnotationReference - Interface in com.veeva.vault.sdk.api.annotation
-
Represents an annotation reference.
- AnnotationReference.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationReference
. - AnnotationReferenceField - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation reference field.
- AnnotationReferenceFieldRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the metadata of an
AnnotationReferenceField
. - AnnotationReferenceFieldRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationReferenceFieldRequest
. - AnnotationReferenceType - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation reference type.
- AnnotationReferenceTypeRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the metadata of an
AnnotationReferenceType
. - AnnotationReferenceTypeRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationReferenceTypeRequest
. - AnnotationReferenceValueSetRequest<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the value set of an
AnnotationReferenceField
on a particularAnnotationReferenceType
. - AnnotationReferenceValueSetRequest.Builder<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationReferenceValueSetRequest
. - AnnotationReferenceValueType<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Types of data supported by
AnnotationReference
s. - AnnotationReplyReadRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Requests to read the replies of a given parent annotation.
- AnnotationReplyReadRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationReplyReadRequest
. - AnnotationService - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to manage document annotations in Vault.
- AnnotationType - Interface in com.veeva.vault.sdk.api.annotation
-
Provides methods to retrieve common metadata information of the specified annotation type.
- AnnotationTypeRequest - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the metadata of an
AnnotationType
. - AnnotationTypeRequest.Builder - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationTypeRequest
. - AnnotationValueSetRequest<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Used to request the value set of an
AnnotationField
on a particularAnnotationType
. - AnnotationValueSetRequest.Builder<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Creates an instance of
AnnotationValueSetRequest
. - AnnotationValueType<T> - Interface in com.veeva.vault.sdk.api.annotation
-
Types of data supported by
Annotation
s. - appendOrderBy(List<String>) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Appends to the
ORDER BY
clause. - 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.
- appendPathWithTokens(String, String) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
Appends a path to a specific connection's base URL using a valid Vault or custom token which will be resolved on send.
- appendReplies(List<Annotation>) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Optional: Specifies replies to append to this annotation.
- appendSelect(Collection<String>) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Appends to the
SELECT
clause. - appendWhere(QueryLogicalOperator, String) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Appends to the
WHERE
clause using the providedQueryLogicalOperator
. - APPLICATION - Enum constant in enum class com.veeva.vault.sdk.api.notification.NotificationMode
-
Indicates that the notification will be displayed as an in-app notification
- APPLICATION_FORM - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Form content type (application/x-www-form-urlencoded).
- APPLICATION_JSON - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
JSON content type (application/json).
- APPLICATION_XML - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Application XML content type (application/xml).
- 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.
- ASSIGNED - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Assigned to a user.
- 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
. - AUTH_AUTHORIZATION_VALUE - Static variable in interface com.veeva.vault.sdk.api.http.HttpTokens
-
Resolves the “Authorization” value generated for the Authorization type associated to a connection
- AUTH_USER_NAME - Static variable in interface com.veeva.vault.sdk.api.http.HttpTokens
-
Resolves the connection authorization's user or login name
- AUTH_USER_PASSWORD - Static variable in interface com.veeva.vault.sdk.api.http.HttpTokens
-
Resolves the connection authorization's password for the login user
- AUTO_MANAGED_GROUP - Enum constant in enum class com.veeva.vault.sdk.api.group.GroupType
-
Groups created and populated automatically by Vaults using Dynamic Access Control.
- AVAILABLE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Available for a user to accept; not assigned.
- AvailableWorkflowInstanceActionsResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Response from a call to
WorkflowInstanceService.getAvailableWorkflowInstanceActions(WorkflowInstanceRequest)
. - AvailableWorkflowMetadata - Interface in com.veeva.vault.sdk.api.workflow
-
Holds basic metadata of an available workflow.
- AvailableWorkflowMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.workflow
-
Request to retrieve a list of
AvailableWorkflowMetadata
for the given list of documents or record IDs. - AvailableWorkflowMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
- AvailableWorkflowMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Holds a list of
AvailableWorkflowMetadata
.
B
- 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.
- 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.
- batchDeleteAnnotations(AnnotationBatchDeleteRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Given a
List
of unique annotation IDs, delete their associated annotations if they are found. - BatchDeleteRecordAttachmentRequest - Interface in com.veeva.vault.sdk.api.data
-
The request object for deleting a list of attachments for the specified object.
- BatchDeleteRecordAttachmentRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
BatchDeleteRecordAttachmentRequest
. - batchDeleteRecordAttachments(BatchDeleteRecordAttachmentRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Performs the deletion of a batch of attachments based on the RecordAttachmentBatchSaveRequest
- batchDeleteRecords(RecordBatchDeleteRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Creates an operation to delete the object records specified in the
RecordBatchDeleteRequest
. - batchDeleteRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Deprecated.
- 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,
E extends BatchOperationError> - Interface in com.veeva.vault.sdk.api.core -
Base interface to be used as a response to batch operations.
- batchProcessRecordDisplayValues(RecordDisplayRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayService
-
Creates an operation to retrieve the display values for the records specified in the
RecordDisplayRequest
. - batchRemoveMatchedDocumentsRequest(BatchRemoveMatchedDocumentsRequest) - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Batch removes one or more manually matched document(s) from an EDL Item.
- BatchRemoveMatchedDocumentsRequest - Interface in com.veeva.vault.sdk.api.edl
-
Contains the payload of one or more manually matched documents to remove from an EDL Item.
- BatchRemoveMatchedDocumentsRequest.Builder - Interface in com.veeva.vault.sdk.api.edl
-
Creates an instance of
BatchRemoveMatchedDocumentsRequest
. - batchSaveAnnotations(AnnotationBatchSaveRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Given a request that includes a
List
ofAnnotation
objects, save the annotations to Vault. - batchSaveMatchedDocumentsRequest(BatchSaveMatchedDocumentsRequest) - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Batch saves one or more matched document(s) to an EDL Item.
- BatchSaveMatchedDocumentsRequest - Interface in com.veeva.vault.sdk.api.edl
-
Contains the payload of one or more matched documents to save to an EDL Item.
- BatchSaveMatchedDocumentsRequest.Builder - Interface in com.veeva.vault.sdk.api.edl
-
Creates an instance of
BatchSaveMatchedDocumentsRequest
. - BatchSaveRecordAttachmentRequest - Interface in com.veeva.vault.sdk.api.data
-
The request object for creating or updating a list of attachments for the specified object.
- BatchSaveRecordAttachmentRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
BatchSaveRecordAttachmentRequest
. - batchSaveRecordAttachments(BatchSaveRecordAttachmentRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Performs the creation or update of a batch of attachments based on the RecordAttachmentBatchSaveRequest
- batchSaveRecords(RecordBatchSaveRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Creates an operation to save the object records specified in the
RecordBatchSaveRequest
. - batchSaveRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Deprecated.as of 22R2.3, replaced by
RecordService.batchSaveRecords(RecordBatchSaveRequest)
- 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
. - BEFORE - Enum constant in enum class com.veeva.vault.sdk.api.core.EventPosition
- BEFORE - Enum constant in enum class com.veeva.vault.sdk.api.role.RecordRoleEvent
-
The trigger executes before the RecordRole change, whether it is adding or removing a role.
- BEFORE_DELETE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- BEFORE_INSERT - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- BEFORE_UPDATE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordEvent
- BLOCK - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Represents the block delete type.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a Yes/No object field.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a Yes/No object field.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with Boolean return type.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type Boolean.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a Yes/No object type field.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type Boolean.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type Boolean.
- BOOLEAN - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a yes/no document field.
- 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.job.JobParamValueType
-
Maps to the "Yes/No" field type in Vault.
- BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.job.JobValueType
-
Maps to the "Yes/No" field type in Vault.
- 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.
- BOOLEAN - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "Yes/No" field type input.
- build() - Method in interface com.veeva.vault.sdk.api.action.PostExecutionUserActionUIBehavior.Builder
-
Creates a new instance of
PostExecutionUserActionUIBehavior
- build() - Method in interface com.veeva.vault.sdk.api.action.PreExecutionUserActionUIBehavior.Builder
-
Create a new instance of
PreExecutionUserActionUIBehavior
- build() - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionBanner.Builder
-
Create a new instance of
UserActionExecutionBanner
. - build() - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionDialog.Builder
-
Create a new instance of
UserActionExecutionBanner
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Retrieves a completed
Annotation
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteRequest.Builder
-
Builds the
AnnotationBatchDeleteRequest
based on the provided data. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveRequest.Builder
-
Builds the
AnnotationBatchSaveRequest
based on the provided data. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationFieldRequest.Builder
-
Validates and retrieves a completed
AnnotationFieldRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemark.Builder
-
Builds a new
AnnotationPlacemark
with the values in the builder set. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkFieldRequest.Builder
-
Validates and retrieves a completed
AnnotationPlacemarkFieldRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkTypeRequest.Builder
-
Validates and retrieves a completed
AnnotationPlacemarkTypeRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueSetRequest.Builder
-
Validates and retrieves a completed
AnnotationPlacemarkValueSetRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadRequest.Builder
-
Builds the
AnnotationReadRequest
based on the provided data. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReference.Builder
-
Builds a new
AnnotationReference
with the values in the builder set. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceFieldRequest.Builder
-
Validates and retrieves a completed
AnnotationReferenceFieldRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceTypeRequest.Builder
-
Validates and retrieves a completed
AnnotationReferenceTypeRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceValueSetRequest.Builder
-
Validates and retrieves a completed
AnnotationReferenceValueSetRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReplyReadRequest.Builder
-
Builds the
AnnotationReplyReadRequest
based on the provided data. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationTypeRequest.Builder
-
Validates and retrieves a completed
AnnotationTypeRequest
. - build() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationValueSetRequest.Builder
-
Validates and retrieves a completed
AnnotationValueSetRequest
. - 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.data.BatchDeleteRecordAttachmentRequest.Builder
-
Validates and retrieves a completed
BatchDeleteRecordAttachmentRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.BatchSaveRecordAttachmentRequest.Builder
-
Validates and retrieves a completed
BatchSaveRecordAttachmentRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
Validates and retrieves a completed
DeleteRecordAttachment
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionRequest.Builder
-
Deprecated.Validates and retrieves a completed
ObjectFieldCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldFilter.Builder
-
Deprecated.Validates and builds an
ObjectFieldFilter
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectFieldMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldRequest.Builder
-
Deprecated.Validates and retrieves a completed
ObjectFieldRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependencyRequest.Builder
-
Validates and retrieves a completed
ObjectPicklistDependencyRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionRequest.Builder
-
Retrieves a completed
ObjectTypeFieldMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Retrieves a completed
ObjectTypeMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
Validates and retrieves a completed
RecordAttachmentFileReferenceRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordBatchDeleteRequest.Builder
-
Validates and builds a
RecordBatchDeleteRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordBatchSaveRequest.Builder
-
Validates and builds a
RecordBatchSaveRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayRequest.Builder
-
Retrieves the completed
RecordDisplayRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeRequest.Builder
-
Retrieves a completed
RecordMergeRequest
. - build() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSetInput.Builder
-
Retrieves a completed
RecordMergeSetInput
. - build() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
Validates and retrieves a completed
SaveRecordAttachment
. - build() - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionRequest.Builder
-
Validates and retrieves a completed
DocumentFieldCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldFilter.Builder
-
Validates and builds a
DocumentFieldFilter
. - build() - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Validates and retrieves a completed
DocumentTypeRequest
. - build() - Method in interface com.veeva.vault.sdk.api.edl.BatchRemoveMatchedDocumentsRequest.Builder
-
Builds and returns a
BatchRemoveMatchedDocumentsRequest
object. - build() - Method in interface com.veeva.vault.sdk.api.edl.BatchSaveMatchedDocumentsRequest.Builder
-
Builds and returns a
BatchSaveMatchedDocumentsRequest
object. - build() - Method in interface com.veeva.vault.sdk.api.edl.RemoveMatchedDocument.Builder
-
Builds and returns a
RemoveMatchedDocument
object. - build() - Method in interface com.veeva.vault.sdk.api.edl.SaveMatchedDocument.Builder
-
Builds and returns a
SaveMatchedDocument
object. - build() - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
To build a FormHttpRequest
- build() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequestBuilder
-
Builds a new
TranslationsReadRequest
object. - build() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Builds an
EvaluateFieldRulesRequest
based on the set parameters. - build() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequestBuilder
-
Create a
GetIntegrationRulesRequest
based on the set parameters. - build() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
Returns a completed
Query
object. - build() - Method in interface com.veeva.vault.sdk.api.job.JobCancelRequest.Builder
-
Validates and returns the completed
JobCancelRequest
. - 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
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleRoleMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleStageGroupMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleStageMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStartWorkflowInputParameter.Builder
-
Validates and retrieves a completed
DocumentLifecycleStartWorkflowInputParameter
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleStateMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleUserActionExecutionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataRequest.Builder
-
Retrieves a completed
DocumentLifecycleUserActionMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadataRequest.Builder
-
Validates and retrieves a completed
DocumentLifecycleUserActionUserInputMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataRequest.Builder
-
Retrieves a completed
DocumentVersionLifecycleUserActionMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleRoleMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleRoleMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStageGroupMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStageGroupMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStageMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStageMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStateMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStateMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStateTypeMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleStateTypeMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionInputParameterMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectLifecycleUserActionInputParameterMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadataRequest.Builder
-
Retrieves a completed
ObjectLifecycleUserActionMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionRequest.Builder
-
Validates and retrieves a completed
ObjectRecordLifecycleMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataRequest.Builder
-
Validates and retrieves a completed
ObjectRecordLifecycleMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionMetadataRequest.Builder
-
Retrieves a completed
ObjectRecordLifecycleUserActionMetadataRequest
Both object name and record ID must be provided. - build() - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Validates and retrieves a completed
UserActionExecutionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistRequest.Builder
-
Validates and retrieves a completed
PicklistRequest
. - build() - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Retrieves the completed
Query
. - build() - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
Retrieves the completed
QueryCountRequest
. - build() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Retrieves the completed
QueryExecutionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetRequest.Builder
-
Returns a completed
QueryFacetRequest
. - build() - Method in interface com.veeva.vault.sdk.api.query.QueryValidationRequest.Builder
-
Retrieves the completed
QueryValidationRequest
. - build() - Method in interface com.veeva.vault.sdk.api.token.TokenRequest.Builder
-
Builds a
TokenRequest
based on the values set in the builder. - build() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionRequest.Builder
-
Validates and constructs a completed
AvailableWorkflowMetadataCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsRequest.Builder
-
Validates and retrieves a completed
WorkflowAddParticipantsRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelRequest.Builder
-
Builds a
WorkflowCancelRequest
based on the values set in the builder. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionRequest.Builder
-
Validates and constructs a completed
WorkflowInstanceCollectionRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceRequest.Builder
-
Validates and retrieves a completed
WorkflowInstanceRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupInputParameter.Builder
-
Validates and constructs a completed
WorkflowParticipantGroupInputParameter
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantInputParameter.Builder
-
Validates and constructs a completed
WorkflowParticipantInputParameter
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsRequest.Builder
-
Validates and retrieves a completed
WorkflowRemoveItemsRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerRequest.Builder
-
Validates and retrieves a completed
WorkflowReplaceOwnerRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceRequest.Builder
-
Validates and retrieves a completed
WorkflowStartInstanceRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataRequest.Builder
-
Validates and retrieves a completed
WorkflowStartMetadataRequest
. - build() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateRequest.Builder
-
Builds a
WorkflowUpdateDueDateRequest
based on the values set in the builder.
C
- cancel(JobCancelRequest) - Method in interface com.veeva.vault.sdk.api.job.JobService
-
Cancels one currently running job entry.
- cancel(WorkflowInstance, List<WorkflowTaskInstance>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskService
-
Cancels the given task instances.
- CANCEL_WORKFLOW - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Cancels an active workflow.
- CANCELLED - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Cancelled; no longer open to complete.
- cancelWorkflow(WorkflowCancelRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowCancelOperation
, which can be used to cancel an active workflow based on the providedWorkflowCancelRequest
. - CANNOT_CANCEL_CUSTOM_SDK_JOB - Enum constant in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
Standard SDK code cannot cancel a custom SDK job.
- CANNOT_CANCEL_NON_SDK_JOB - Enum constant in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
An SDK user cannot cancel a non-SDK job.
- CANNOT_CANCEL_STANDARD_SDK_JOB - Enum constant in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
Custom SDK code cannot cancel a standard SDK job.
- CASCADE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Represents the cascade delete type.
- CLASSIFICATION - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
The classification level.
- 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.annotation - package com.veeva.vault.sdk.api.annotation
-
This package provides interfaces to manage document annotations in Vault.
- 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 Vault Java SDK Logs and User-Defined Model.
- 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.edl - package com.veeva.vault.sdk.api.edl
-
This package provides interfaces to batch save and remove matched documents.
- com.veeva.vault.sdk.api.email - package com.veeva.vault.sdk.api.email
-
This package provides interfaces to create documents and content based on emails sent to Vault.
- 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.lifecycle - package com.veeva.vault.sdk.api.lifecycle
-
This package provides interfaces to retrieve configuration metadata for object and document lifecycles and actions, and to execute actions.
- 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 perform various operations using VQL queries and retrieve information 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.token - package com.veeva.vault.sdk.api.token
-
This package provides interfaces to define and resolve custom tokens.
- com.veeva.vault.sdk.api.workflow - package com.veeva.vault.sdk.api.workflow
-
This package provides interfaces to create custom actions for workflows, inititate workflow actions, and update entities within workflow processing.
- COMMENT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- COMPLETED - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Completed by the assignee.
- 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.
- COMPLEX - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataJoinType
-
Represents the complex join type.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a component object field, such as the Lifecycle field.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a component object field, such as the Lifecycle field.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type component.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a component object type field, such as the Lifecycle field.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type component.
- COMPONENT - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a component document field.
- CONFIG_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Message was not delivered because the Spark integration may not be properly configured.
- ConfigurationContext - Interface in com.veeva.vault.sdk.api.action
-
Represents contextual information for an action, such as the usage context the action is configured and executed against and parameter values set by Admins in the object configuration for the action.
- CONNECTION_AUTHORIZED_USER - Enum constant in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Authorized user defined in the connection record.
- CONNECTION_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Indicates a connection error or failure.
- CONNECTION_FAILED - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Indicates that connection to target URL failed.
- CONNECTION_FAILED - Enum constant in enum class com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Message was not delivered to its destination.
- CONNECTION_USER_SESSION_ID - Static variable in interface com.veeva.vault.sdk.api.http.HttpTokens
-
Resolves a valid Vault session token for the Authorized Connection User on the Connection record.
- 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 Class 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 property is present on the object.
- containsField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.Given the field name, checks to see if an
ObjectField
exists with the name. - containsField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionResponse
-
Given the field name, checks to see if an
ObjectFieldMetadata
exists with the name. - containsField(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionResponse
-
Given the field name, checks to see if an
DocumentField
exists with the name. - containsField(String) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Retrieves the status of the field on this row.
- containsLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataResponse
-
Given the document lifecycle name, checks to see if a
DocumentLifecycleMetadata
exists with the name. - containsLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionResponse
-
Given the object lifecycle name, checks to see if an
ObjectLifecycleMetadata
exists with the name. - containsLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionResponse
-
Given the object record ID, checks to see if an
ObjectRecordLifecycleMetadata
exists. - containsObjectType(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionResponse
-
Given the object type name, checks to see if an
ObjectTypeMetadata
exists with the name. - containsObjectTypeField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionResponse
-
Given the object type name, checks to see if an
ObjectTypeFieldMetadata
exists with the name. - containsRequestExecutionContext(Class<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Indicates whether the current request is part of the specified contextType.
- containsRole(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataResponse
-
Given the document lifecycle role name, checks to see if a
DocumentLifecycleRoleMetadata
exists with the name. - containsRole(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionResponse
-
Given the object lifecycle role name, checks to see if an
ObjectLifecycleRoleMetadata
exists with the name. - containsStage(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataResponse
-
Given the document lifecycle stage name, checks to see if a
DocumentLifecycleStageMetadata
exists with the name. - containsStage(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionResponse
-
Given the object lifecycle stage name, checks to see if an
ObjectLifecycleStageMetadata
exists with the name. - containsStageGroup(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataResponse
-
Given the document lifecycle stage group name, checks to see if a
DocumentLifecycleStageGroupMetadata
exists with the name. - containsStageGroup(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionResponse
-
Given the object lifecycle stage group name, checks to see if an
ObjectLifecycleStageGroupMetadata
exists with the name. - containsState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataResponse
-
Given the document lifecycle state name, checks to see if a
DocumentLifecycleStateMetadata
exists with the name. - containsState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionResponse
-
Given the object lifecycle state name, checks to see if an
ObjectLifecycleStateMetadata
exists with the name. - containsStateType(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionResponse
-
Given the object lifecycle state type name, checks to see if an
ObjectLifecycleStateTypeMetadata
exists with the name. - containsSubquery(String) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Retrieves the status of the sub-query on this row.
- containsUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataResponse
-
Given the document lifecycle user action name, checks to see if a
DocumentLifecycleUserActionMetadata
exists with the name. - containsUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataResponse
-
Given the document lifecycle user action name, checks to see if a
DocumentVersionLifecycleUserActionDetail
exists with the name. - containsUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionCollectionResponse
-
Given the object lifecycle user action name, checks to see if an
ObjectLifecycleUserActionMetadata
exists with the name. - containsUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionCollectionResponse
-
Given the object lifecycle user action name, checks to see if an
ObjectRecordLifecycleUserActionDetail
exists with the name. - containsWorkflow(String) - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionResponse
-
Given the workflow name, checks to see if an
AvailableWorkflowMetadata
exists with the name. - containsWorkflowInstance(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionResponse
-
Given the workflow ID, checks to see if a
WorkflowInstance
exists with the ID. - 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.
- CORPORATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Represents the corporate currency type for currency formula fields.
- count(QueryCountRequest) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Creates an operation to count the records qualified by the given
queryCountRequest
. - CR_LF - Enum constant in enum class com.veeva.vault.sdk.api.csv.LineEnding
-
Line ending that consists of a carriage return (CR) followed by a line feed (LF).
- createAttachments(List<? extends SharedAttachment>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Creates new attachment- or attachment-versions for a document or an object record.
- CREATED - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordAttachmentPositionResultType
-
An attachment is created.
- 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
-
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.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a currency object field.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a currency object field.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with currency return type.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type currency.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a currency object type field.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type currency.
- CURRENCY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type currency.
- CUSTOM - Enum constant in enum class com.veeva.vault.sdk.api.data.SourceType
-
This is a representation of a custom source type.
D
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a date object field.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a date object field.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with date return type.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type date.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a date object type field.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type date.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type date.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a date document field.
- DATE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- 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.job.JobParamValueType
-
Maps to the "Date" field type in Vault.
- DATE - Static variable in interface com.veeva.vault.sdk.api.job.JobValueType
-
Maps to the "Date" field type in Vault.
- DATE - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
-
Maps to the "Date" field type in Vault.
- DATE - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "Date" field type input.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a DateTime object field.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a DateTime object field.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with DateTime return type.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type DateTime.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a DateTime object type field.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type DateTime.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type DateTime.
- DATETIME - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a DateTime document field.
- DATETIME - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationValueType
-
Used by fields that specify a date and a time.
- 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.job.JobParamValueType
-
Maps to the "DateTime" field type in Vault.
- DATETIME - Static variable in interface com.veeva.vault.sdk.api.job.JobValueType
-
Maps to the "DateTime" field type in Vault.
- DATETIME - Static variable in interface com.veeva.vault.sdk.api.queue.MessageAttributeValueType
-
Maps to the "DateTime" field type in Vault.
- DATETIME - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "DateTime" field type input.
- 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.
- defaultValue() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedProperty
-
The default value to assign to this user-defined property.
- DefaultValueExpressionMetadata - Interface in com.veeva.vault.sdk.api.data
-
A container for a default value expression.
- defaultValues() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedProperty
-
The default value(s) to assign to this user-defined property.
- DELETE - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpMethod
- deleteDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Delete the specified List of
DocumentVersion
s. - DeleteDocumentVersionsResponse - Interface in com.veeva.vault.sdk.api.document
-
Response from a call to
DocumentService.deleteDocumentVersions(List)
(List)}. - DeleteRecordAttachment - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to delete a record attachment.
- DeleteRecordAttachment.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
DeleteRecordAttachment
. - deleteRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Deprecated.as of 17R2.2, replaced by
RecordService.batchDeleteRecords(RecordBatchDeleteRequest)
- DeleteRecordsResponse - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 17R2.2, see
RecordService.deleteRecords(List)
- DESCRIPTION - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- DISPLAY_PARTICIPANTS - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs when displaying participants in the workflow start step.
- DOCUMENT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Maps to the
WorkflowItemDocument
item type in a workflow - DOCUMENT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowType
-
Document Workflow
- DOCUMENT_FIELD - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- DOCUMENT_LIFECYCLE_STATE - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- DOCUMENT_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error that occurred because a specified document version cannot be found for any reason, including because the document version no longer exists, or because the user does not have permission to view it.
- DOCUMENT_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationReadErrorType
-
The specified document version cannot be found for any reason, including if the document version no longer exists, or the user does not have permission to view it.
- DOCUMENT_NOT_VALID_FOR_DELETE - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorType
-
Represents an error due to an issue with the document that the annotation is attached to.
- DOCUMENT_NOT_VALID_FOR_SAVE - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to an issue with the document that the annotation is attached to.
- DOCUMENT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a document reference object field.
- DOCUMENT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a document reference object field.
- DOCUMENT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a document reference object type field.
- DOCUMENT_TYPE - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- DOCUMENT_UNBOUND - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of an unbound document reference Field.
- DOCUMENT_UNBOUND - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of an unbound document reference Field.
- 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 Interface in com.veeva.vault.sdk.api.action
-
Indicates a class is a document action.
- DocumentAttachment - Interface in com.veeva.vault.sdk.api.document
-
Represents the target attachment.
- DocumentAttachmentFileReference - Interface in com.veeva.vault.sdk.api.document
-
Represents an attachment file from the current or from another Vault.
- DocumentField - Interface in com.veeva.vault.sdk.api.document
-
Provides methods to retrieve common metadata information of the specified document field.
- DocumentFieldCollectionRequest - Interface in com.veeva.vault.sdk.api.document
-
Retrieves a List of all fields in the
DocumentField
collection once a request is built for the given document type. - DocumentFieldCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.document
-
Creates an instance of
DocumentFieldCollectionRequest
. - DocumentFieldCollectionResponse - Interface in com.veeva.vault.sdk.api.document
-
Holds a
DocumentField
collection. - DocumentFieldFilter - Interface in com.veeva.vault.sdk.api.document
-
Provides methods to retrieve required, unique, all, or a specific subset of document fields.
- DocumentFieldFilter.Builder - Interface in com.veeva.vault.sdk.api.document
-
Creates an instance of
DocumentFieldFilter
. - DocumentFieldType - Enum Class in com.veeva.vault.sdk.api.document
-
A list of all of the possible field types that a document field can be.
- DocumentFileReference - Interface in com.veeva.vault.sdk.api.document
-
Represents a document file from the current or from another Vault.
- DocumentLifecycleMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle.
- DocumentLifecycleMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple document lifecycles in the format of
DocumentLifecycleMetadata
collection. - DocumentLifecycleMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleMetadataRequest
. - DocumentLifecycleMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleMetadata
collection. - DocumentLifecycleMetadataService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve document lifecycle, state, stage group, stage, and role metadata.
- DocumentLifecycleRoleMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle role.
- DocumentLifecycleRoleMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple document lifecycle roles in the format of
DocumentLifecycleRoleMetadata
collection. - DocumentLifecycleRoleMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleRoleMetadataRequest
. - DocumentLifecycleRoleMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleRoleMetadata
collection. - DocumentLifecycleStageGroupMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle stage group.
- DocumentLifecycleStageGroupMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple document lifecycle stage groups in the format of
DocumentLifecycleStageGroupMetadata
collection. - DocumentLifecycleStageGroupMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleStageGroupMetadataRequest
. - DocumentLifecycleStageGroupMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleStageGroupMetadata
collection. - DocumentLifecycleStageMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle stage.
- DocumentLifecycleStageMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple document lifecycle stages in the format of
DocumentLifecycleStageMetadata
collection. - DocumentLifecycleStageMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleStageMetadataRequest
. - DocumentLifecycleStageMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleStageMetadata
collection. - DocumentLifecycleStartWorkflowInputParameter - Interface in com.veeva.vault.sdk.api.lifecycle
-
Container for input parameters necessary to execute a Run Workflow document lifecycle user action.
- DocumentLifecycleStartWorkflowInputParameter.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleStartWorkflowInputParameter
. - DocumentLifecycleStateMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle state.
- DocumentLifecycleStateMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple document lifecycle states in the format of
DocumentLifecycleStateMetadata
collection. - DocumentLifecycleStateMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleStateMetadataRequest
. - DocumentLifecycleStateMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleStateMetadata
collection. - DocumentLifecycleStateUserActionMetadataService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata about document lifecycle user action, document version lifecycle user action, and user action user input.
- DocumentLifecycleStateUserActionService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to execute a document lifecycle user action.
- DocumentLifecycleUserActionExecutionError - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents an error encountered during a
DocumentLifecycleUserActionExecutionOperation
. - DocumentLifecycleUserActionExecutionOperation - Interface in com.veeva.vault.sdk.api.lifecycle
-
A sequence of instructions that can be chained together, building a document lifecycle user action execution operation that can be executed with
DocumentLifecycleUserActionExecutionOperation.execute()
. - DocumentLifecycleUserActionExecutionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to set the parameters necessary to execute a document lifecycle user action.
- DocumentLifecycleUserActionExecutionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleUserActionExecutionRequest
. - DocumentLifecycleUserActionExecutionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents the result of the execution of a document lifecycle user action.
- DocumentLifecycleUserActionMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document lifecycle user action.
- DocumentLifecycleUserActionMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve metadata about document lifecycle user actions in the format of
DocumentLifecycleUserActionMetadataResponse
. - DocumentLifecycleUserActionMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleUserActionMetadataRequest
. - DocumentLifecycleUserActionMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentLifecycleUserActionMetadata
collection. - DocumentLifecycleUserActionUserInputMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific document action's input.
- DocumentLifecycleUserActionUserInputMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve user action user input metadata, in the format of
DocumentLifecycleUserActionUserInputMetadata
. - DocumentLifecycleUserActionUserInputMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentLifecycleUserActionUserInputMetadataRequest
. - DocumentMetadataService - Interface in com.veeva.vault.sdk.api.document
-
Provides methods to retrieve document type and document field metadata.
- DocumentRendition - Interface in com.veeva.vault.sdk.api.document
-
Represents the target document-version rendition.
- DocumentRenditionFileReference - Interface in com.veeva.vault.sdk.api.document
-
Represents a document-version rendition file from the current or from another Vault.
- 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
DocumentRole
s. - 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.
- DocumentSourceFileReference - Interface in com.veeva.vault.sdk.api.document
-
Represents a document-version source file from the current or from another Vault.
- DocumentType - Interface in com.veeva.vault.sdk.api.document
-
Provides methods to retrieve common metadata information of the specified document type.
- DocumentTypeLevel - Enum Class in com.veeva.vault.sdk.api.document
-
A list of all possible levels a
DocumentType
can be. - DocumentTypeRequest - Interface in com.veeva.vault.sdk.api.document
-
Retrieves an instance of
DocumentType
to build the request for retrieving document type metadata. - DocumentTypeRequest.Builder - Interface in com.veeva.vault.sdk.api.document
-
Creates an instance of
DocumentTypeRequest
. - DocumentVersion - Interface in com.veeva.vault.sdk.api.document
-
Represents a document version.
- DocumentVersionLifecycleUserActionDetail - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents the metadata associated with a lifecycle user action for a particular document version.
- DocumentVersionLifecycleUserActionMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve metadata about document lifecycle user actions on a specific document version in the format of
DocumentVersionLifecycleUserActionMetadataResponse
. - DocumentVersionLifecycleUserActionMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
DocumentVersionLifecycleUserActionMetadataRequest
. - DocumentVersionLifecycleUserActionMetadataResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds a
DocumentVersionLifecycleUserActionDetail
collection. - DUPLICATE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordAttachmentPositionResultType
-
An attachment with the same name and checksum already exists, no-op (no operation).
E
- EDITABLE_FIELDS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
List of selected fields in this result that are editable for the querying user.
- EMAIL - Enum constant in enum class com.veeva.vault.sdk.api.notification.NotificationMode
-
Indicates that the notification will be sent to the user's email
- EmailAddress - Interface in com.veeva.vault.sdk.api.email
-
Represents an email address.
- EmailBodyType - Enum Class in com.veeva.vault.sdk.api.email
-
Represents the body type of an email.
- EmailFileReference - Interface in com.veeva.vault.sdk.api.email
-
Represents a file attached to an email.
- EmailItem - Interface in com.veeva.vault.sdk.api.email
-
Represents a single email.
- EmailProcessor - Interface in com.veeva.vault.sdk.api.email
-
Invoked to process an email received by the Vault Email Service.
- EmailProcessorContext - Interface in com.veeva.vault.sdk.api.email
-
Provides access to contextual information exposed in an Email Processor.
- EmailProcessorInfo - Annotation Interface in com.veeva.vault.sdk.api.email
-
Indicates a class is an
EmailProcessor
. - EmailRecipient - Interface in com.veeva.vault.sdk.api.email
-
Represents the recipient of the email.
- EmailSender - Interface in com.veeva.vault.sdk.api.email
-
Represents the sender of the email.
- EmailSenderType - Enum Class in com.veeva.vault.sdk.api.email
-
Represents the types of senders from whom an email processor can receive emails.
- EmailService - Interface in com.veeva.vault.sdk.api.email
-
A service to interact with emails received by Vault.
- EMPTY - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldMissingValueBehaviorType
-
Formula will treat blank fields as empties
- empty integer: 0 (eg. - error(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs an ERROR type message to the Debug Log and Runtime Log.
- error(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs the templated ERROR type message to the Debug Log and Runtime 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 and Runtime Log.
- ErrorProvider - Interface in com.veeva.vault.sdk.api.queue
-
Provides a method to set an error record in Vault.
- ErrorResult - Interface in com.veeva.vault.sdk.api.core
-
Represents an error.
- ERRORS_ENCOUNTERED - Enum constant in enum class com.veeva.vault.sdk.api.job.TaskState
- escape(String) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Deprecated.This method only escapes single quotes and backslashes and does not provide a way to escape other special characters. As of 21R3.4, the preferred escape utility is
QueryService.escapeValue(String, QueryEscapeOverride...)
which escapes all VQL special characters by default and supports overriding the default escape strategy. - ESCAPE_ALL - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates no overrides are applied to the default escape strategy.
- escapeValue(String, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Escapes all VQL special characters in a string for use in a VQL statement.
- evaluateFieldRules(EvaluateFieldRulesRequest) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Evaluates a constructed
EvaluateFieldRulesRequest
. - evaluateFieldRules(IntegrationRule, String, JsonObject, JsonObject) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Deprecated.as of 19R3.2, replaced by
IntegrationRuleService.evaluateFieldRules(EvaluateFieldRulesRequest)
- EvaluateFieldRulesRequest - Interface in com.veeva.vault.sdk.api.integration
-
Provides the data needed to evaluate a field rule; built from
EvaluateFieldRulesRequestBuilder
. - EvaluateFieldRulesRequestBuilder - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to build an
EvaluateFieldRulesRequest
; built fromIntegrationRuleService.newEvaluateFieldRulesRequestBuilder()
. - EvaluateFieldRulesResponse - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information about an evaluated field rule; returned from
IntegrationRuleService.evaluateFieldRules(EvaluateFieldRulesRequest)
. - EventPosition - Enum Class in com.veeva.vault.sdk.api.core
-
Indicates whether a
RecordEvent
orRecordRoleEvent
occurs before or after an event-specific occurrence. - events() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordTriggerInfo
-
Events for which the trigger should be invoked.
- events() - Element in annotation interface com.veeva.vault.sdk.api.role.RecordRoleTriggerInfo
-
Events for which the trigger should be invoked.
- eventSegment() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordTriggerInfo
-
Event segment in which a trigger shall execute.
- eventSegment() - Element in annotation interface com.veeva.vault.sdk.api.role.RecordRoleTriggerInfo
-
Event segment in which a trigger shall execute.
- EventSegment - Enum Class in com.veeva.vault.sdk.api.core
-
For internal Veeva use only.
- excludeFromTotal(boolean) - Method in interface com.veeva.vault.sdk.api.edl.SaveMatchedDocument.Builder
-
Optional: Sets whether to exclude the matched document from the EDL Item's set of matched documents.
- execute() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadOperation
-
Executes this read operation.
- execute() - Method in interface com.veeva.vault.sdk.api.core.BatchOperation
-
Executes the batch operation.
- execute() - Method in interface com.veeva.vault.sdk.api.core.VaultInformationOperation
-
Executes this request to obtain remote Vault information.
- execute() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeOperation
-
Executes the record merge operation, which starts the record merge job.
- execute() - Method in interface com.veeva.vault.sdk.api.http.HttpOperation
-
Executes the HTTP operation.
- execute() - Method in interface com.veeva.vault.sdk.api.job.JobCancelOperation
-
Executes this cancel job operation.
- execute() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionOperation
-
Executes the user action.
- execute() - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionOperation
-
Executes the user action.
- execute() - Method in interface com.veeva.vault.sdk.api.query.QueryOperation
-
Executes this query operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsOperation
-
Executes this workflow add participants operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelOperation
-
Executes this workflow cancel operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsOperation
-
Executes this workflow remove items operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerOperation
-
Executes this workflow replace owner operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceOperation
-
Executes this workflow start operation.
- execute() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateOperation
-
Executes this workflow update due date operation.
- 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(RecordTriggerContext) - Method in interface com.veeva.vault.sdk.api.data.RecordTrigger
-
Invoked to start a trigger.
- execute(EmailProcessorContext) - Method in interface com.veeva.vault.sdk.api.email.EmailProcessor
-
Email processing logic is implemented inside this method.
- 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.
- execute(RecordWorkflowActionContext) - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowAction
-
Invoked on execution of a
WorkflowEvent
. - executeUserAction(DocumentLifecycleUserActionExecutionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionService
-
Creates an instance of
DocumentLifecycleUserActionExecutionOperation
, which can be used to execute the user action based on theDocumentLifecycleUserActionExecutionRequest
. - executeUserAction(UserActionExecutionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionService
-
Creates an instance of
UserActionExecutionOperation
, which can be used to execute the user action based on theUserActionExecutionRequest
. - ExpressionMetadata - Interface in com.veeva.vault.sdk.api.data
-
A container for an expression.
F
- FAILED_TO_RUN - Enum constant in enum class com.veeva.vault.sdk.api.job.TaskState
- FAILURE - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordMergeCompletionStatus
-
Indicates an unsuccessful record merge.
- FEATURE_DISABLED - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to an issue with a feature setting in the Vault Admin UI associated with the save operation.
- FieldRule - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information related to a FieldRule.
- FieldRuleError - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve the error type and message associated with a field rule.
- FieldRuleResult - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information after evaluating a field rule.
- FieldType - Interface in com.veeva.vault.sdk.api.core
-
Common interface for all field types.
- FileReference - Interface in com.veeva.vault.sdk.api.file
-
Represents a file location in either the current Vault or in a different Vault.
- FormatMaskExpressionMetadata - Interface in com.veeva.vault.sdk.api.data
-
A container for a format mask expression.
- formatTranslation(String, Map<String, String>) - Method in interface com.veeva.vault.sdk.api.i18n.TranslationService
-
Replaces Message tokens with values.
- FormHttpRequest - Interface in com.veeva.vault.sdk.api.http
-
A HttpRequest replacing
HttpRequest
- FormHttpRequest.Builder - Interface in com.veeva.vault.sdk.api.http
- FORMULA - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a formula object field.
- FORMULA - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a formula object field.
- FORMULA - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a formula object type field.
- FORMULA - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a formula document field.
- fromTemplate(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Creates a document from the given template.
G
- GENERIC - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- get() - Static method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the context of the current request.
- GET - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpMethod
- GET_PARTICIPANTS - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs when saving the provided participants to the participant group, which occurs immediately after the start step dialog is submitted.
- getAllHeaders() - Method in interface com.veeva.vault.sdk.api.csv.CsvHeaders
-
Returns a list of CSV headers.
- getAllowedPlacemarkTypes() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationType
-
Retrieves the placemark types that this annotation type allows.
- getAllowedReferenceTypes() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationType
-
Retrieves the reference types that this annotation type allows.
- getAllPicklistValues() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
Retrieves all
PicklistValue
objects for this picklist. - getAssigneeId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the user ID of the assignee.
- getAttachmentExternalId() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment
-
Get external ID of the attachment
- getAttachmentExternalId() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the external ID of the attachment.
- getAttachmentId() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment
-
Get the attachment ID.
- getAttachmentId() - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentPositionResult
-
Retrieves the attachment ID, for example, "60".
- getAttachmentId() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the ID of the attachment.
- getAttachmentName() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the Name of the attachment.
- getAttachmentVersionId() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment
-
Get the version of the attachment.
- getAttachmentVersionId() - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentPositionResult
-
Retrieves the version ID of the attachment, for example, "1", "2", and so on.
- getAttachmentVersionId() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the version ID of the attachment, e.g., "1", "2", and so on.
- getAttribute(String, MessageAttributeValueType<T>) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
Retrieves an attribute set by
Message.setAttribute(String, Object)
. - getAvailableWorkflowInstanceActions(WorkflowInstanceRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Gets the available workflow actions for the provided workflow instance.
- getAvailableWorkflows(AvailableWorkflowMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowMetadataService
-
Retrieves a list of available workflows for the given documents or record IDs.
- getBaseFieldMetadata() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldTypeMetadata
-
Retrieves the
ObjectFieldMetadata
version of the given typed formula field. - getBaseFieldMetadata() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldTypeMetadata
-
Retrieves the
ObjectFieldMetadata
version of the given typed lookup field. - getCcAddresses() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves a list of carbon copy email addresses.
- getClassificationLabel() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document classification label of the given document type.
- getClassificationName() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document classification name of the given document type.
- getColumnIndex(String) - Method in interface com.veeva.vault.sdk.api.csv.CsvHeaders
-
Returns the index of the given column name.
- getComponentName() - Method in interface com.veeva.vault.sdk.api.data.ObjectComponentFieldMetadata
-
Retrieves the component name of the given component field.
- 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.query.QueryWeblink
-
Retrieves the API name of the Connection object record, if one was set in the
hyperlink
function. - 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. - getControllingField() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves the name of the controlling field of the given picklist field.
- getControllingField() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the controlling field of the given reference field.
- getControllingValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependency
-
Retrieves the controlling value of the given object picklist dependency.
- getCount() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResult
-
Retrieves the number of values in the result.
- getCount() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetValue
-
Retrieves the number of records with this value that satisfy the
Query
conditions. - getCreatedByUserId() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the user that created the given object field.
- getCreatedDate() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the date that the given object field was created.
- getCreatedDate() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstance
-
Retrieves the created date of the workflow.
- getCurrencyType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadata
-
Retrieves the
ObjectFormulaCurrencyFieldMetadataReturnType
of the given formula currency field. - 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
-
Deprecated.as of 22R3.4, replaced with
RequestContext.getInitiatingUserId()
andRequestContext.getRequestOwnerUserId()
. - getDataStore() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the type of data store used by this object.
- getDataType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves the data value type of the parameter.
- getDefaultObjectType() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the default object type of this object.
- getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeBooleanFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given Boolean field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeCurrencyFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given currency field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeDateFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given date field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeDateTimeFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given DateTime field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeLongTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given long text field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeNumberFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given number field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeObjectReferenceFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given object reference field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeParentReferenceFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given parent reference field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypePicklistFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given picklist field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeRichTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given rich text field. - getDefaultValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given text field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectBooleanFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given Boolean field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given currency field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectDateFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given date field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectDateTimeFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given DateTime field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectLongTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given long text field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given number field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given parent reference field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given picklist field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given object reference field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectRichTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given rich text field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given text field. - getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectUnboundDocumentFieldMetadata
-
Retrieves the
DefaultValueExpressionMetadata
containing the default value expression of the given unbound document field. - getDescription() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the description of the given object field.
- getDescription() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the description of the attachment.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the description of this document lifecycle in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the description of this document lifecycle stage group in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the description of this document lifecycle stage in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadata
-
Retrieves the description of this document lifecycle state in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the description of this object lifecycle in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the description of this object lifecycle stage group in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the description of this object lifecycle stage in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the description of this object lifecycle state in the current user's language.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the description of this object lifecycle state type in the current user's language.
- getDisplayFormat() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
Retrieves the display format on the given text field.
- getDisplayName() - Method in interface com.veeva.vault.sdk.api.email.EmailAddress
-
Retrieves the display name of this email address, for example, "Vern User" in "Vern User <vern_user+vaultId=123@veeva.com>."
- getDisplayValue(String) - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayResult
-
Given the field name, retrieves the display value.
- getDns() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the Vault DNS.
- getDocumentActionClassName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadata
-
For document actions, retrieves the fully qualified Java class name of the configured DocumentAction.
- 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
-
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 assignedDocumentRole
s for a given document. - GetDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve
DocumentRole
, returned fromDocumentRoleService.getDocumentRoles(List, String)
. - getDocumentType(DocumentTypeRequest) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Retrieves a single
DocumentType
. - getDocumentTypeDetailId() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document type detail record id of the given document type.
- 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. - getDocumentVersionId() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentResult
-
Retrieves the document version ID of the processed matched document.
- 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.
- getDocumentVersionUserActions(DocumentVersionLifecycleUserActionMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
-
Retrieves all lifecycle user actions available for the document version in its current state.
- getDomain() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the Vault domain.
- getDomain() - Method in interface com.veeva.vault.sdk.api.email.EmailAddress
-
Retrieves the domain of this email address, for example, "veeva.com" in "Vern User <vern_user+vaultId=123@veeva.com>."
- getDueDate() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the due date for the current task instance.
- getDuplicateRecordId() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSet
-
Retrieves the duplicate record ID of the merge set.
- getEdlItemId() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentResult
-
Retrieves the EDL Item ID provided in the request.
- getEmailAddress() - Method in interface com.veeva.vault.sdk.api.email.EmailRecipient
-
Retrieves the email address of this email recipient.
- getEmailAddress() - Method in interface com.veeva.vault.sdk.api.email.EmailSender
-
Retrieves the email address of this sender.
- getEmailAttachments() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves a list of email attachments that were sent with this email.
- getEmailBody(String, EmailBodyType) - Method in interface com.veeva.vault.sdk.api.email.EmailService
-
Retrieves the body of the email as HTML or plain text.
- getEmailBodySize(EmailBodyType) - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the size in bytes of this email body.
- getEmailFile() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves a
FileReference
pointing to the stored .eml file to be used to create a document or attachment. - getEmailItem() - Method in interface com.veeva.vault.sdk.api.email.EmailProcessorContext
-
Retrieves the
EmailItem
to be processed. - getEnvelopeName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstance
-
Retrieves the workflow's envelope name.
- getError() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteError
-
Returns details about the error that occurred at this position.
- getError() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveError
-
Returns details about the error that occurred at this position.
- 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.data.RecordMergeError
-
Retrieves the
ErrorResult
of this RecordMergeError. - getError() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentError
-
Retrieves details about the error that occurred at this position.
- 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.
- getErrors() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeOperationError
-
Retrieves the List of errors that occured while attempting to start a record merge.
- getErrorTasks() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
Retrieves the list of tasks in this
Job
that completed with errors or failed. - getErrorType() - Method in interface com.veeva.vault.sdk.api.core.VaultInformationOperationError
- getErrorType() - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentBatchOperationError
-
The error type for the batch operation error.
- getErrorType() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeError
-
Retrieves the error type of this RecordMergeError.
- getErrorType() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionError
-
Retrieves the type of error encountered during a
DocumentLifecycleUserActionExecutionOperation
. - getErrorType() - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionOperationError
-
Retrieves the type of error encountered during a
UserActionExecutionOperation
- getErrorType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowActionError
-
Retrieves the
ActionErrorType
encountered during a workflow action - getErrorType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceError
-
Retrieves the type of error encountered during a
WorkflowStartInstanceOperation
. - 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 class com.veeva.vault.sdk.api.data.RecordEvent
- getEventPosition() - Method in enum class com.veeva.vault.sdk.api.role.RecordRoleEvent
- getExpressionString() - Method in interface com.veeva.vault.sdk.api.data.ExpressionMetadata
-
Retrieves the given expression.
- getFacetResponse() - Method in interface com.veeva.vault.sdk.api.query.QueryCountResponse
-
Retrieves the
QueryFacetResponse
. - getFacetResponse() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResponse
-
Retrieves the
QueryFacetResponse
. - getField(AnnotationFieldRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationField
. - getField(ObjectFieldRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Deprecated.as of 23R1.3, replaced by
ObjectMetadataService.getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)
- getField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.Given the field name, retrieves the
ObjectField
. - getField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionResponse
-
Given the field name, retrieves the
ObjectFieldMetadata
. - getField(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionResponse
-
Given the field name, obtains the
DocumentField
. - getField(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Retrieves a single
DocumentField
. - getFieldCount() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.Retrieves the number of entries in the collection.
- getFieldCount() - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionResponse
-
Retrieves the number of entries in the collection.
- getFieldDefault() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
The static default value.
- getFieldName() - Method in interface com.veeva.vault.sdk.api.query.QueryWeblink
-
Retrieves the name of this weblink field.
- getFieldNames() - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayResult
-
Returns the list of field names present in the result set.
- getFieldNames() - Method in interface com.veeva.vault.sdk.api.query.QueryEditableFieldResult
-
Retrieves the List of selected fields that are editable for the querying user.
- getFieldNames() - Method in interface com.veeva.vault.sdk.api.query.QueryHiddenFieldResult
-
Retrieves the List of selected fields hidden on this result row for the querying user.
- getFieldNames() - Method in interface com.veeva.vault.sdk.api.query.QueryRedactedFieldResult
-
Retrieves the List of selected fields redacted from this result row for the querying user.
- getFieldNames() - Method in interface com.veeva.vault.sdk.api.query.QueryWeblinkFieldResult
-
Retrieves the List of selected weblink fields from this result row.
- 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 thisIntegrationrule
component. - getFields() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkType
-
Retrieves the names of the fields that can be retrieved for the given annotation placemark type.
- getFields() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceType
-
Retrieves the names of the fields that can be retrieved for this annotation reference type, and can also be set if the field does not have additional restrictions.
- getFields() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationType
-
Retrieves the names of the fields that can be retrieved for this annotation type.
- getFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.Retrieves a list of the object fields in the native format,
ObjectField
. - getFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionResponse
-
Retrieves a collection of
ObjectFieldMetadata
. - getFields(ObjectFieldCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Deprecated.as of 23R1.3, replaced by
ObjectMetadataService.getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)
- getFields(DocumentFieldCollectionRequest) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Retrieves a
DocumentFieldCollectionResponse
. - getFieldType() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the
ObjectFieldType
of the given object field. - getFieldType() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the
DocumentFieldType
of the given document field. - getFileName() - Method in interface com.veeva.vault.sdk.api.email.EmailFileReference
-
Retrieves the name of this file.
- getFileSize() - Method in interface com.veeva.vault.sdk.api.email.EmailFileReference
-
Retrieves the size of this file in bytes.
- getFilterClause() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Retrieves this
QueryObjectRule
clause with any tokens unresolved. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaNumberFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given number formula field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaTextFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given text formula field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupCurrencyFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given currency lookup field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupNumberFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given number lookup field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupTextFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given text lookup field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given number field. - getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
Retrieves the
FormatMaskExpressionMetadata
containing the format mask expression of the given text field. - getFormulaExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
Retrieves the
ObjectFormulaFieldExpressionMetadata
containing the formula expression of the given formula field. - getFullAddress() - Method in interface com.veeva.vault.sdk.api.email.EmailAddress
-
Retrieves this whole email address, for example, "Vern User <vern_user+vaultId=123@veeva.com>."
- getFullyQualifiedActionName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the fully qualified action name, in the format of:
Objectaction.vobjectName.actionName
, orObjectlifecyclestateuseraction.vobjectName.stateName.actionName
. - 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 fromRecordRoleService.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
. - 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
-
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.email.EmailItem
-
Retrieves a list of email header names.
- 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.email.EmailItem
-
Retrieves a list of email header values for the given header name.
- 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.
- getHelpContent() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the help content of the given object field.
- 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.core.VaultInformation
-
Retrieves the Vault ID.
- getId() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the ID of the given object type.
- getId() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the ID of the
email__sys
record. - getId() - Method in interface com.veeva.vault.sdk.api.group.Group
-
Retrieve group ID.
- getId() - Method in interface com.veeva.vault.sdk.api.job.JobOwner
-
Retrieves the ID of the job owner.
- 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.WorkflowItemDocument
-
Retrieves the
id
of the document associated with this item. - getId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the ID of the current task instance.
- getInboundEmailAddressName() - Method in interface com.veeva.vault.sdk.api.email.EmailProcessorContext
-
Retrieves the name of the inbound email address component.
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the inbound relationship label of the given document reference field.
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the inbound relationship label of the given parent reference field.
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the inbound relationship label of the given reference field.
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the inbound relationship name of the given document reference field.
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the inbound relationship name of the given parent reference field.
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the inbound relationship name of the given reference field.
- getInitiatingUserId() - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Returns the id of the user who initiated the SDK request.
- getInputParameterMetadata(ObjectLifecycleUserActionInputParameterMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
-
Retrieves an instance of
ObjectLifecycleUserActionInputParameterMetadata
, containing details about the user input object if the action is a RecordAction annotated with auser_input_object
. - 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
-
Retrieves the list of
IntegrationRule
s. - getIntegrationRules(GetIntegrationRulesRequest) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Retrieves the list of
IntegrationRules
corresponding to a Connection based on theGetIntegrationRulesRequest
. - getIntegrationRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Deprecated.as of 19R3.2, replaced by
IntegrationRuleService.getIntegrationRules(GetIntegrationRulesRequest)
- getIntegrationRulesByIntegrationPoint(String, String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Deprecated.as of 19R3.2, replaced by
IntegrationRuleService.getIntegrationRules(GetIntegrationRulesRequest)
- GetIntegrationRulesRequest - Interface in com.veeva.vault.sdk.api.integration
-
Provides the data needed to retrieve a specific set of integration rules; built from
GetIntegrationRulesRequestBuilder.build()
. - GetIntegrationRulesRequestBuilder - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to build a
GetIntegrationRulesRequest
; built fromIntegrationRuleService.newGetIntegrationRulesRequestBuilder()
. - GetIntegrationRulesResponse - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information associated with an integration rule; returned from
IntegrationRuleService.getIntegrationRules(GetIntegrationRulesRequest)
. - getItems() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the input List of job items for a given task.
- getJobCancelOperationErrorType() - Method in interface com.veeva.vault.sdk.api.job.JobCancelOperationError
-
Returns the type of error encountered during job cancellation.
- getJobId() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeEventContext
-
Retrieves the job ID of the job running the merge.
- getJobId() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeOperationResponse
-
Retrieves the job ID of the record merge job.
- getJobId() - Method in interface com.veeva.vault.sdk.api.job.JobCancelResponse
-
Retrieves the ID of the cancelled job instance.
- 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
-
Retrieves job parameters set by
JobInitContext.setJobInitParameter(String, Object)
. - getJobInitParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves job parameters that are set on
Job.init(JobInitContext)
. - 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.JobContext
-
Retrieves the name of the job.
- getJobName() - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Gets the name of the job specified in a
JobParameters
object. - getJobOwner() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the
JobOwner
of the job. - getJobParameter(String, JobParamValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves job parameters set on
JobParameters
when invoking a job throughJobService
. - getJobParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves job parameters set on
JobParameters
when invoking a job throughJobService
. - 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.
- getJoinType() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the join type of this object.
- getJsonArray() - Method in interface com.veeva.vault.sdk.api.json.JsonData
-
Retrieves the top-level
JsonArray
for the JSON data. - getJsonObject() - Method in interface com.veeva.vault.sdk.api.json.JsonData
-
Retrieves the top-level
JsonObject
for the JSON data. - getJsonValueType() - Method in interface com.veeva.vault.sdk.api.json.JsonProperty
-
Retrieves the JSON value type of this property.
- getLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.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.ObjectFieldMetadata
-
Retrieves the label value of the given object field in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the label value of the given object in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the label value of the given object type.
- getLabel() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the label value, in the current user's language, of the given document field.
- 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.lifecycle.DocumentLifecycleMetadata
-
Retrieves the label value of this document lifecycle in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the label value of this document lifecycle stage group in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the label value of this document lifecycle stage in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadata
-
Retrieves the label value of this document lifecycle state in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadata
-
Retrieves the label value, in the current user's language, of this document lifecycle user action.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the label value of this object lifecycle in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the label value of this object lifecycle stage group in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the label value of this object lifecycle stage in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the label value of this object lifecycle state in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the label value of this object lifecycle state type in the current user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle user action.
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
Retrieves this
Picklist
's UI label. - 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.query.QueryFacetResult
-
Retrieves the field label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetValue
-
Retrieves the label for the value if requested in the
QueryFacetRequest
. - getLabel() - Method in interface com.veeva.vault.sdk.api.query.QueryWeblink
-
Retrieves the text that appears as a link in the UI.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadata
-
Retrieves the label of the workflow in the user's language.
- 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.WorkflowInstance
-
Retrieves the label of the workflow in the user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves the label of the parameter in the user's language.
- 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.WorkflowStartStepMetadata
-
Retrieves the label of the control in the user's language.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskConfiguration
-
Returns the label of this task, as seen by task assignees.
- getLabelPlural() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the plural label value of the given object type.
- getLanguage() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the specified Vault-supported language code.
- getLanguageCode() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the
admin_key__sys
field value for the Language object record indicated in the Base Language setting as configured on the Language & Region Settings page in the Vault Admin UI. - 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.
- getLevel() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the
DocumentTypeLevel
of the document type. - getLifecycle(ObjectLifecycleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleMetadata
. - getLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataResponse
-
Given the document lifecycle name, retrieves the
DocumentLifecycleMetadata
. - getLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionResponse
-
Given the object lifecycle name, retrieves the
ObjectLifecycleMetadata
. - getLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionResponse
-
Given the object record ID, obtains the
ObjectRecordLifecycleMetadata
. - getLifecycleLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the label value of the record's object lifecycle in the current user's language.
- getLifecycleName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the name of document lifecycle associated with this document lifecycle stage group.
- getLifecycleName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the name of object lifecycle associated with this object lifecycle stage group.
- getLifecycleName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the name of the record's object lifecycle.
- getLifecycleNames() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document lifecycle names of the given document type.
- 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.
- getLifecycles() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataResponse
-
Retrieves all the document lifecycles in this collection as a List of
DocumentLifecycleMetadata
. - getLifecycles() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionResponse
-
Retrieves all the object lifecycles in this collection as a list of
ObjectLifecycleMetadata
. - getLifecycles() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionResponse
-
Retrieves all the object lifecycles in this collection as a list of
ObjectRecordLifecycleMetadata
. - getLifecycles(DocumentLifecycleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Retrieves multiple
DocumentLifecycleMetadata
containing the metadata of the requested document lifecycles. - getLifecycles(ObjectLifecycleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleMetadata
. - getLifecycleUserActions(ObjectLifecycleUserActionMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
-
Retrieves all lifecycle user actions and object actions configured for a given lifecycle state.
- getLineEnding() - Method in enum class com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the line ending as a
String
. - getLocaleCode() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the
admin_key__sys
field value for the Locale object record indicated in the Base Locale setting as configured on the Language & Region Settings page in the Vault Admin UI. - getLocalVaultInformation() - Method in interface com.veeva.vault.sdk.api.core.VaultInformationService
-
Retrieves information about the local Vault.
- getLookupFieldType() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves the
ObjectLookupFieldType
of the given lookup field. - getLookupTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves a subclass of
ObjectLookupFieldTypeMetadata
so you can fetch the lookup type field attributes of the given formula field. - getMainRecordId() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSet
-
Retrieves the main record ID of the merge set.
- getMajorVersion() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemDocument
-
Retrieves the major version of the document associated with this item.
- getMaximumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the maximum value of the given currency field.
- getMaximumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadata
-
Retrieves the maximum value of the given formula currency field.
- getMaximumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaNumberFieldMetadata
-
Retrieves the maximum value of the given number formula field.
- getMaximumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
Retrieves the maximum value of the given number field.
- getMaximumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectUnboundDocumentFieldMetadata
-
Retrieves the maximum value of the given unbound document field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaTextFieldMetadata
-
Retrieves the max length value of the given text formula field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectLongTextFieldMetadata
-
Retrieves the max length value of the given object long text field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectRichTextFieldMetadata
-
Retrieves the max length value of the given rich text object field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
Retrieves the max length value of the given text field.
- getMd5Checksum() - Method in interface com.veeva.vault.sdk.api.email.EmailFileReference
-
Retrieves the MD5 checksum of this file.
- getMessage() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorResult
-
Retrieves a human-readable message about the error.
- getMessage() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorResult
-
Returns a human-readable message about the error.
- getMessage() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadErrorResult
-
Returns a human-readable message about the error.
- 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.core.VaultInformationOperationError
- getMessage() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentErrorResult
-
Retrieves a human-readable message about the error.
- 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.job.JobCancelOperationError
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionError
-
Retrieves a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionOperationError
-
Retrieves a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.query.QueryOperationError
-
Retrieves 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.
- getMessage() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowActionError
-
Returns a human-readable error message.
- getMessage() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceError
-
Retrieves a human-readable error message.
- getMessageContext() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandlerContext
-
Retrieves the contextual information about a Message.
- getMessageContext() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandlerSendContext
-
Retrieves 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.email.EmailItem
-
Retrieves the Message-ID header value of this email.
- 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.setMessageItems(List)
. - getMessages() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the optional collection of Message names.
- getMetadata() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionDetail
-
Retrieves the
DocumentLifecycleUserActionMetadata
associated with this user action. - getMetadata() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionDetail
-
Retrieves the
ObjectLifecycleUserActionMetadata
associated with this user action. - getMimeType() - Method in interface com.veeva.vault.sdk.api.email.EmailFileReference
-
Retrieves the MIME type of this file.
- getMinimumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the minimum value of the given currency field.
- getMinimumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadata
-
Retrieves the minimum value of the given formula currency field.
- getMinimumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaNumberFieldMetadata
-
Retrieves the minimum value of the given number formula field.
- getMinimumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
Retrieves the minimum value of the given number field.
- getMinimumValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectUnboundDocumentFieldMetadata
-
Retrieves the minimum value of the given unbound document field.
- getMinorVersion() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemDocument
-
Retrieves the minor version of the document associated with this item.
- 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. - 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. - 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.
- getMissingFieldValueBehaviorType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
Retrieves the
ObjectFormulaFieldMissingValueBehaviorType
of the given formula field. - getModifiedByUserId() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves most recent user that modified the given object field.
- getModifiedDate() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the date that the given object field was last modified.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationField
-
Retrieves the name of the given annotation field.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkField
-
Returns the name of the given annotation placemark field.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkType
-
Returns the name of the given annotation placemark type.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceField
-
Returns the name of the annotation reference field.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceType
-
Returns the name of the annotation reference type.
- getName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationType
-
Returns the name of the annotation type.
- getName() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the Vault name.
- getName() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the name of the given object field.
- getName() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
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.data.ObjectTypeFieldMetadata
-
Retrieves the name of the given object type field.
- getName() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the name of the given object type.
- getName() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the name of the given document field.
- 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.json.JsonProperty
-
Retrieves the name of this property.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the name of this document lifecycle.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadata
-
Retrieves the name of this document lifecycle role.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the name of this document lifecycle stage group.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the name of this document lifecycle stage.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadata
-
Retrieves the name of this document lifecycle state.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the name of this object lifecycle.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadata
-
Retrieves the name of this object lifecycle.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the name of this object lifecycle stage group.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the name of this object lifecycle stage.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the name of this object lifecycle state.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the name of this object lifecycle state type.
- getName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the component name of this object lifecycle user action.
- getName() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
Retrieves this
Picklist
's name. - getName() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
-
Retrieves a picklist value's name.
- getName() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResult
-
Retrieves the name of the field.
- getName() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadata
-
Retrieves the name of the workflow.
- 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.WorkflowInstance
-
Retrieves the name of the workflow.
- getName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves the name of the parameter.
- 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
-
Retrieves a single
ObjectMetadata
. - getObjectClass() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the string value of object class of the given object.
- getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Retrieves multiple
ObjectFieldMetadata
. - getObjectFieldMetadataType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the
ObjectFieldMetadataType
of the given object field. - getObjectFieldMetadataType() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves the
ObjectTypeFieldMetadataType
of the given object type field. - getObjectFormulaTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
Retrieves a subclass of
ObjectFormulaFieldTypeMetadata
so you can fetch the formula type field attributes of the given formula field. - getObjectName() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment
-
Return object name of the attachment (together with the record id to associate the attachment).
- getObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the object name of the given object field.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the name of the object this object type is associated with.
- 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.data.RecordMergeEventContext
-
Retrieves the name of the object that the merging records belong to.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the object name of the attachment together with the record ID to associate the attachment.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the name of the object associated with this object lifecycle.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the name of the object for which the trigger is invoked.
- getObjectName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemRecord
-
Retrieves the name of the object associated with this item.
- getObjectPicklistDependencies(ObjectPicklistDependencyRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Retrieves multiple
ObjectPicklistDependency
. - getObjectRecordId() - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment
-
Return record id of the attachment (together with the object name to associate the attachment).
- getObjectRecordId() - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment
-
Retrieves the record ID of the attachment together with the object name to associate the attachment.
- getObjectType(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionResponse
-
Given the object type name, retrieves the
ObjectTypeMetadata
. - getObjectTypeField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionResponse
-
Given the object type field name, retrieves the
ObjectTypeFieldMetadata
. - getObjectTypeFieldMetadata() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldTypeMetadata
-
Retrieves the
ObjectTypeFieldMetadata
version of the given object type formula field. - getObjectTypeFieldMetadata() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldTypeMetadata
-
Retrieves the
ObjectTypeFieldMetadata
version of the given object type lookup field. - getObjectTypeFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionResponse
-
Retrieves a collection of
ObjectTypeFieldMetadata
. - getObjectTypeFields(ObjectTypeFieldMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Retrieves multiple
ObjectTypeFieldMetadata
. - getObjectTypeFormulaTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldMetadata
-
Retrieves a subclass of
ObjectTypeFormulaFieldTypeMetadata
, which allows you to fetch the formula type field attributes of the given formula field. - getObjectTypeLookupTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldMetadata
-
Retrieves a subclass of
ObjectTypeLookupFieldTypeMetadata
, which allows you to fetch the lookup type field attributes of the given lookup field. - getObjectTypeName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the name of object type associated with this object lifecycle stage group.
- getObjectTypes() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionResponse
-
Retrieves a collection of
ObjectTypeMetadata
. - getObjectTypes(ObjectTypeMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Retrieves multiple
ObjectTypeMetadata
. - 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.
- getOrder() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the display order of the given object field.
- getOrder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the order of this document lifecycle stage.
- getOrder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadata
-
Retrieves the order of this document lifecycle state.
- getOrder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the order of this object lifecycle stage.
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the outbound relationship name of the given document reference field.
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the outbound relationship name of the given parent reference field.
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the outbound relationship name of the given reference field.
- getOwnerId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstance
-
Retrieves the current workflow owner.
- getParameters() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartStepMetadata
-
Retrieves the list of
WorkflowParameterMetadata
. - 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.
- getPersonId() - Method in interface com.veeva.vault.sdk.api.email.EmailSender
-
Retrieves the Person ID for this sender; null if the email address does not match any Person records or if the email address matches multiple active Person records.
- getPicklist(PicklistRequest) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
Given a picklist
PicklistRequest
, returns aPicklist
object which can be used to retrieve picklist information. - getPicklist(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
Given a picklist
Name
, returns aPicklist
object which can be used to retrieve picklist information. - getPicklistDependencies() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependencyResponse
-
Retrieves a List of
ObjectPicklistDependency
objects. - getPicklistEntries() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypePicklistFieldMetadata
-
Retrieves a list of picklist entries associated with the given picklist.
- getPicklistName() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves the picklist name used by the given picklist field.
- getPicklistValue(String) - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
Retrieves a
PicklistValue
object for a specific picklist value name. - getPicklistValues() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependency
-
Retrieves the dependent picklist values of the given object picklist dependency.
- getPlacemark() - Method in interface com.veeva.vault.sdk.api.annotation.Annotation
-
Returns the placemark of the annotation, such as the text it appears on, the page it appears on, or the coordinates it appears on.
- getPlacemarkField(AnnotationPlacemarkFieldRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationPlacemarkField
. - getPlacemarkType(AnnotationPlacemarkTypeRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationPlacemarkType
. - getPlacemarkValueSet(AnnotationPlacemarkValueSetRequest<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves the value set for a particular placemark field on a particular placemark type.
- getPluralLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the plural label value of the given object in the current user's language.
- getPrimaryQueryObject() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the name of the primary query object of this integration rule.
- getProperties() - Method in interface com.veeva.vault.sdk.api.json.JsonObject
-
Retrieves a
Map
representing the properties of the JSON object. - getPutMessageResults() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
Retrieves a list of
PutMessageResult
objects. - 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. - getQueryFieldSelect() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the "Query Field Select" attribute from the field rule, if added.
- getQueryFieldType(Class<T>) - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
- 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 theIntegrationrule
- getQueryObjectRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves any
Queryobjectrules
which have the specified value for their object field. - getQueryOperationErrorType() - Method in interface com.veeva.vault.sdk.api.query.QueryOperationError
-
Retrieves the type of error encountered during a
QueryOperation
execution. - getQueryRecordPropertyTypes() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Retrieves the List of
QueryRecordPropertyType
s available on this record. - getQueryString() - Method in interface com.veeva.vault.sdk.api.query.Query
-
Retrieves a VQL query string representation of the Query.
- getQueryString() - Method in interface com.veeva.vault.sdk.api.query.QueryCountResponse
-
Retrieves the executed query string.
- getQueryString() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResponse
-
Retrieves the executed query string.
- getQueryString() - Method in interface com.veeva.vault.sdk.api.query.QueryOperationError
-
Retrieves the query string that failed.
- getQueryString() - Method in interface com.veeva.vault.sdk.api.query.QueryValidationResponse
-
Retrieves the validated query string.
- getQueueName() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the name of the queue which received this Message.
- getRecipient() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the recipient of this email.
- getRecord() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves the
Record
object's name and record ID. - getRecordActionClassName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
For object actions, retrieves the fully qualified Java class name of the configured RecordAction.
- 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.
- getRecordId() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the ID of the object record.
- getRecordId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemRecord
-
Retrieves the
id
of the object record associated with this item. - 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.
- getRecordLifecycle(ObjectRecordLifecycleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves
ObjectRecordLifecycleMetadata
for a specific object record. - getRecordLifecycles(ObjectRecordLifecycleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves the
ObjectRecordLifecycleMetadata
for multiple object records. - getRecordLifecycleUserActions(ObjectRecordLifecycleUserActionMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
-
Retrieves all user actions and object actions configured for the object record and its lifecycle state.
- getRecordMergeSetResults() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeEventCompletionContext
-
Retrieves the results of the attempted merge.
- getRecordMergeSets() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeEventStartContext
-
Retrieves the record merge sets which passed all validation.
- getRecordRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the
RecordRole
where a change applied. - getRecordRole(Record) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
Retrieves a
RecordRole
for a given record. - getRecordRole(Record, String) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
Retrieves RecordRole for a given record and role.
- 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.as of 18R2.3, replaced by
RecordRoleService.getRecordRoles(List, String)
. - 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
RecordRole
s, returned fromRecordRoleService.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
- 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
-
Deprecated.as of 23R1.2 Use
RecordWorkflowActionContext.getWorkflowItems()
to retrieve the items in the workflow. - getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the referenced object name of the given document reference field.
- getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the referenced object name of the given parent reference field.
- getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the referenced object name of the given reference field.
- getReferenceField(AnnotationReferenceFieldRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationReferenceField
. - 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
-
The
ReferenceLookupType
of the fieldrule. - getReferences() - Method in interface com.veeva.vault.sdk.api.annotation.Annotation
-
Returns the references associated with this annotation.
- getReferenceType(AnnotationReferenceTypeRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationReferenceType
. - getReferenceValueSet(AnnotationReferenceValueSetRequest<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves the value set for a particular reference field on a particular reference type.
- getRelatedCorporateCurrencyField() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the related Corporate Currency field name for the given currency field.
- getRelatedDocument() - Method in interface com.veeva.vault.sdk.api.data.ObjectUnboundDocumentFieldMetadata
-
Retrieves the related document field of the given unbound document field.
- getRelatedLocalCurrencyField() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the related Local Currency field name for the given currency field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the relationship criteria of the given document reference field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the relationship criteria of the given parent reference field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the relationship criteria of the given reference field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeObjectReferenceFieldMetadata
-
Retrieves the relationship criteria of the given reference field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeParentReferenceFieldMetadata
-
Retrieves the relationship criteria of the given reference field.
- getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the
ObjectReferenceFieldMetadataDeleteType
of the given document reference field. - getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieves the
ObjectReferenceFieldMetadataDeleteType
of the given parent reference field. - getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves the
ObjectReferenceFieldMetadataDeleteType
of the given reference field. - getRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves the name of the relationship to the source object of the given lookup field.
- getRelationshipNames() - Method in interface com.veeva.vault.sdk.api.query.QueryHiddenSubqueryResult
-
Retrieves the List of hidden subqueries on this result row for the querying user.
- 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.
- getRemoteVaultInformation(ConnectionContext) - Method in interface com.veeva.vault.sdk.api.core.VaultInformationService
-
Retrieves information about the remote Vault associated with the given Vault-to-Vault connection.
- getRemovedItems() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsResponse
-
List of items successfully removed in the remove item action.
- getRequestExecutionContext(Class<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Gets the current request execution context of the provided contextType if available, and throws a
RuntimeException
if it is not present. - getRequestOwnerUserId() - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Returns the id of the user who owns the SDK request.
- 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.annotation.AnnotationReadResponse
-
Retrieves the total number of annotations found by the read request.
- getResultCount() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResponse
-
Retrieves the total number of results satisfying the query.
- getResultCount() - Method in interface com.veeva.vault.sdk.api.query.QueryResponse
-
Deprecated.Retrieves the total number of results satisfying the query.
- getResults() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResponse
-
A List of
QueryFacetResult
s in the order in which they were requested in theQueryFacetRequest
. - getResultType() - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentPositionResult
-
Returns the result type regarding how the attachment was saved.
- 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.lifecycle.DocumentLifecycleRoleMetadata
-
Retrieves the application role associated with this document lifecycle role.
- getRole() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadata
-
Retrieves the application role associated with this object lifecycle role.
- 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. - getRole(ObjectLifecycleRoleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleRoleMetadata
. - getRole(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataResponse
-
Given the document lifecycle role name, retrieves the
DocumentLifecycleRoleMetadata
. - getRole(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionResponse
-
Given the object lifecycle role name, retrieves the
ObjectLifecycleRoleMetadata
. - 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
. - getRoleNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the names of all the lifecycle roles configured in this document lifecycle.
- getRoleNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the names of all the lifecycle roles configured in this object lifecycle.
- getRoles() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataResponse
-
Retrieves all the document lifecycle roles in this collection as a List of
DocumentLifecycleRoleMetadata
. - getRoles() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionResponse
-
Retrieves all the object lifecycle roles in this collection as a list of
ObjectLifecycleRoleMetadata
. - getRoles() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a list of application roles contained in this participant group.
- getRoles(DocumentLifecycleRoleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Retrieves multiple
DocumentLifecycleRoleMetadata
containing the metadata of the requested document lifecycle roles. - getRoles(ObjectLifecycleRoleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleRoleMetadata
. - getRow(int) - Method in interface com.veeva.vault.sdk.api.csv.CsvData
-
Returns a
Row
of data at a given index. - getScale() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the scale of the given currency field.
- getScale() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadata
-
Retrieves the scale of the given formula currency field.
- getScale() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaNumberFieldMetadata
-
Retrieves the scale of the given number formula field.
- getScale() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
Retrieves the scale of the given number field.
- getSender() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the sender of this email.
- getSentDate() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the date this email was sent.
- 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
-
Retrieves the number of elements in the array.
- getSource() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves the
SourceType
of the given object type field. - getSourceField() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves the source field of the given lookup field.
- getSourceObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves the source object of the given lookup field.
- 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. - getSourceType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the
SourceType
of the given object field. - getStage(ObjectLifecycleStageMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleStageMetadata
. - getStage(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataResponse
-
Given the document lifecycle stage name, retrieves the
DocumentLifecycleStageMetadata
. - getStage(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionResponse
-
Given the object lifecycle stage name, retrieves the
ObjectLifecycleStageMetadata
. - getStageGroup(ObjectLifecycleStageGroupMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleStageGroupMetadata
. - getStageGroup(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataResponse
-
Given the document lifecycle stage group name, retrieves the
DocumentLifecycleStageGroupMetadata
. - getStageGroup(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionResponse
-
Given the object lifecycle stage group name, retrieves the
ObjectLifecycleStageGroupMetadata
. - getStageGroupName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the name of the stage group associated with this document lifecycle.
- getStageGroupNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the names of all the stage groups associated with this object lifecycle.
- getStageGroups() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataResponse
-
Retrieves all the document lifecycle stage groups in this collection as a List of
DocumentLifecycleStageGroupMetadata
. - getStageGroups() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionResponse
-
Retrieves all the object lifecycle stage groups in this collection as a list of
ObjectLifecycleStageGroupMetadata
. - getStageGroups(DocumentLifecycleStageGroupMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Retrieves multiple
DocumentLifecycleStageGroupMetadata
containing the metadata of the requested document lifecycle stage groups. - getStageGroups(ObjectLifecycleStageGroupMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleStageGroupMetadata
. - getStageName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the name of the record's object lifecycle stage if it exists.
- getStageNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the names of the stages in this document lifecycle stage group.
- getStageNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the names of the stages in this object lifecycle stage group.
- getStages() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataResponse
-
Retrieves all the document lifecycle stages in this collection as a List of
DocumentLifecycleStageMetadata
. - getStages() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionResponse
-
Retrieves all the object lifecycle stages in this collection as a list of
ObjectLifecycleStageMetadata
. - getStages(DocumentLifecycleStageMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Retrieves multiple
DocumentLifecycleStageMetadata
containing the metadata of the requested document lifecycle stages. - getStages(ObjectLifecycleStageMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleStageMetadata
. - getStartStepMetadataList() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataResponse
-
Retrieves the list of
WorkflowStartStepMetadata
needed to start the workflow. - getState() - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the task state for a specific state.
- getState(ObjectLifecycleStateMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleStateMetadata
. - getState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataResponse
-
Given the document lifecycle state name, retrieves the
DocumentLifecycleStateMetadata
. - getState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionResponse
-
Given the object lifecycle state name, retrieves the
ObjectLifecycleStateMetadata
. - getStateLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the label value of the record's object lifecycle state in the current user's language.
- getStateName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the name of the lifecycle state associated with this state type.
- getStateName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the name of the record's object lifecycle state.
- getStateNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the names of all the states configured in this document lifecycle.
- getStateNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the names of the document lifecycle states associated with this document lifecycle stage.
- getStateNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the names of all the states configured in this object lifecycle.
- getStateNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the names of the object lifecycle states associated with this object lifecycle stage.
- getStates() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataResponse
-
Retrieves all the document lifecycle states in this collection as a list of
DocumentLifecycleStateMetadata
. - getStates() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionResponse
-
Retrieves all the object lifecycle states in this collection as a list of
ObjectLifecycleStateMetadata
. - getStates(DocumentLifecycleStateMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Retrieves multiple
DocumentLifecycleStateMetadata
containing the metadata of the requested document lifecycle states. - getStates(ObjectLifecycleStateMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleStateMetadata
. - getStateType(ObjectLifecycleStateTypeMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves a single
ObjectLifecycleStateTypeMetadata
. - getStateType(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionResponse
-
Given the object lifecycle state type name, retrieves the
ObjectLifecycleStateTypeMetadata
. - getStateTypeNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the names of the state types configured in this object lifecycle.
- getStateTypeNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the names of all the state types associated to this object lifecycle state.
- getStateTypeNames() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the names of the record's object lifecycle state types.
- getStateTypes() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionResponse
-
Retrieves all the object lifecycle state types in this collection as a list of
ObjectLifecycleStateTypeMetadata
. - getStateTypes(ObjectLifecycleStateTypeMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Retrieves multiple
ObjectLifecycleStateTypeMetadata
. - getStatus() - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSetResult
-
Retrieves the status of a merge set after it has completed a merge.
- getStatus() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the status of the current task instance.
- getStepType() - Method in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Indicates the associated
WorkflowStepType
for this workflow event. - getSubAddress() - Method in interface com.veeva.vault.sdk.api.email.EmailAddress
-
Retrieves the subAddress of this email address, for example, "vaultId=123" in "Vern User <vern_user+vaultId=123@veeva.com>."
- getSubject() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves the subject line of this email.
- getSubqueryResponse(String) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Returns the results from a nested SELECT-FROM for the specified inbound relationship in a Left Outer Join Query.
- getSubqueryResponse(String) - Method in interface com.veeva.vault.sdk.api.query.QueryResult
-
Deprecated.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.
- getSubtypeLabel() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document subtype label of the given document type.
- getSubtypeName() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document subtype name of the given document type.
- 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.
- getSuccessTasks() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
Retrieves the list of tasks in this
Job
that completed successfully. - getSummaryFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the names of fields that Vault displays in the Summary Info panel on object record detail pages.
- getSummaryFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the names of fields that Vault displays in the Summary Info panel on record detail pages for this object type.
- getTarget() - Method in interface com.veeva.vault.sdk.api.query.QueryWeblink
-
Retrieves the
QueryWeblinkTarget
. - 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.
- getTargetFieldLookup() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the value of the
target_field_lookup
attribute from the field rule, if specified. - 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.
- getTargetObjFieldRefObj() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the Vault object that the target object field references, if the
target_object_field
is an object reference field as specified in the field rule. - 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
-
Retrieves the
WorkflowTaskConfiguration
for the current task step, if the event is forWorkflowStepType.TASK
. - getTaskContext() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the
RecordWorkflowActionTaskContext
containing information for the current task step, if the current event is executing for a task step. - 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
-
Deprecated.as of 22R2.2, replaced by
JobCompletionContext.getSuccessTasks()
andJobCompletionContext.getErrorTasks()
.
Retrieves the list of tasks in thisJob
. - getTimeZoneName() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the Vault Time Zone value as configured on the Language & Region Settings page in the Vault Admin UI.
- getToAddresses() - Method in interface com.veeva.vault.sdk.api.email.EmailItem
-
Retrieves a list of To email addresses.
- 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.
- getTotalCount() - Method in interface com.veeva.vault.sdk.api.query.QueryCountResponse
-
Retrieves the total number of records qualified by the count query.
- 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.annotation.AnnotationBatchDeleteErrorResult
-
Retrieves a general type associated with the error.
- getType() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorResult
-
Returns a general type associated with the error.
- getType() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadErrorResult
-
Returns a general type associated with the error.
- 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 beSDK_ERROR
. Thesubtype
value specified by Vault Java SDK Code can be retrieved usingErrorResult.getSubtype()
- getType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
Retrieves the
ObjectFormulaFieldType
of the given formula field. - getType() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldMetadata
-
Retrieves the
ObjectTypeFormulaFieldType
of the given formula field. - getType() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldMetadata
-
Retrieves the
ObjectTypeLookupFieldType
of the given lookup field. - getType() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentErrorResult
-
Retrieves a general type associated with the error.
- 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.job.JobOwner
-
Retrieves the type of the job owner (either user or group).
- getType() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the type of this object lifecycle user action, or null if the action is an object action configured on all lifecycle states.
- getType() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResult
-
Retrieves the
QueryFacetResultType
for this result. - getType() - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryError
-
Retrieves the error type of the failed Spark message delivery.
- getType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartStepMetadata
-
Retrieves the start step type.
- getType(AnnotationTypeRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves a single
AnnotationType
. - getTypedObjectFieldMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves a subclass of
ObjectFieldMetadata
. - getTypedObjectTypeFieldMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves a subclass of
ObjectTypeFieldMetadata
, which allows you to fetch the type field attributes of the given object type field. - getTypedQueryRecordProperty(Class<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Retrieves a subclass of
QueryRecordPropertyResult
, containing additional metadata about this record and its fields. - getTypedWorkflowItem(Class<T>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItem
-
Retrieves the WorkflowItem as a
WorkflowItemRecord
orWorkflowItemDocument
. - getTypeLabel() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document type label of the given document type.
- getTypeName() - Method in interface com.veeva.vault.sdk.api.annotation.Annotation
-
Returns the name of the annotation type of this annotation.
- getTypeName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemark
-
Returns the name of the type of this annotation placemark.
- getTypeName() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReference
-
Returns the name of the type of this annotation reference.
- getTypeName() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the document type name of the given document type.
- getTypeName() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResultType
-
Retrieves the field's data type in Vault.
- getTypeValidations() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the object type validation rule names as a collection of
String
. - getUnprocessed() - Method in interface com.veeva.vault.sdk.api.document.SaveDocumentVersionsResponse
-
Retrieves the unprocessed document IDs due to insufficient access.
- getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataResponse
-
Given the document lifecycle user action name, retrieves the
DocumentLifecycleUserActionMetadata
. - getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataResponse
-
Given the document lifecycle user action name, retrieves the
DocumentVersionLifecycleUserActionDetail
. - getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionCollectionResponse
-
Given the object lifecycle user action name, obtains the
ObjectLifecycleUserActionMetadata
. - getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionCollectionResponse
-
Given the object lifecycle user action name, obtains the
ObjectRecordLifecycleUserActionDetail
. - getUserActionName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadata
-
Retrieves the user action name of this document lifecycle user action.
- getUserActionName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the user action name of this object lifecycle user action.
- getUserActions() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataResponse
-
Retrieves the document lifecycle user actions as a List of
DocumentLifecycleUserActionMetadata
. - getUserActions() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataResponse
-
Retrieves the document version lifecycle user actions as a List of
DocumentVersionLifecycleUserActionDetail
. - getUserActions() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionCollectionResponse
-
Gets the object lifecycle user actions as a list of
ObjectLifecycleUserActionMetadata
. - getUserActions() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionCollectionResponse
-
Gets the object record lifecycle user actions as a list of
ObjectRecordLifecycleUserActionDetail
. - getUserActions(DocumentLifecycleUserActionMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
-
Retrieves all lifecycle user actions configured for a given lifecycle state.
- getUserId() - Method in interface com.veeva.vault.sdk.api.email.EmailSender
-
Retrieves the User ID for this sender; null if the email address does not match any User records or if the email address matches multiple active User records.
- getUserInDocumentRoles(String, List<DocumentRole>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
For a given
userId
, retrieves aGetUserInDocumentRolesResponse
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.
- getUserInput(DocumentLifecycleUserActionUserInputMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
-
Retrieves an instance of
ObjectLifecycleUserActionInputParameterMetadata
, containing details about the user input object if the action is a DocumentAction annotated with auser_input_object
. - getUserInputObjectName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadata
-
If the requested action is a DocumentAction annotated with a
user_input_object
, then retrieves the name of theuser_input_object
. - getUserInputObjectName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionInputParameterMetadata
-
If the requested action is a RecordAction annotated with a
user_input_object
, then retrieves the name of theuser_input_object
. - getUserInputObjectTypeName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadata
-
If the requested action is a DocumentAction annotated with a
user_input_object_type
, then retrieves the name of theuser_input_object_type
. - getUserInputObjectTypeName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionInputParameterMetadata
-
If the requested action is a RecordAction annotated with a
user_input_object_type
, then retrieves the name of theuser_input_object_type
. - 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.
- getUserName() - Method in interface com.veeva.vault.sdk.api.email.EmailAddress
-
Retrieves the username of this email address, for example, "vern_user" in "Vern User <vern_user+vaultId=123@veeva.com>."
- 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() - 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() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetValue
-
Retrieves the query facet value.
- 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(int, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonArray
-
Retrieves a value contained at the given index.
- getValue(String, AnnotationPlacemarkValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemark
-
Returns the value of the field with the given name and type.
- getValue(String, AnnotationReferenceValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReference
-
Returns the value of the field with the given name and type.
- getValue(String, AnnotationValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation
-
Returns the value of the field with the given name and type.
- 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, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.action.ConfigurationContext
-
Retrieves a parameter's value.
- 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(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResult
-
Retrieves value of the given field.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryResult
-
Deprecated.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.
- getValue(String, JobValueType<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, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonObject
-
Retrieves the value of a property with the given name.
- 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(String, Class<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.TaskOutput
-
Retrieves the value identified by the given
name
from the task output. - 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.
- getValues(ValueType<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResult
-
Retrieves a List of
QueryFacetValue
s in thisQueryFacetResult
. - getValueSet(AnnotationValueSetRequest<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Retrieves the value set for a particular field on a particular annotation type.
- getValueType() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationField
-
Retrieves the
AnnotationValueType
of the given annotation field. - getValueType() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkField
-
Returns the value type of the given annotation placemark field.
- getValueType() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceField
-
Returns the value type of the annotation reference field.
- getValueType() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the
ValueType
of the given object field. - getValueType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the
ValueType
of the given object field. - getValueType() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves the
ValueType
of the given object type field. - getValueType() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the
ValueType
of the given document field. - getValueType() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResultType
-
Retrieves the SDK
ValueType
for the values in theQueryFacetResult
. - getVersionType() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves the
ObjectDocumentReferenceFieldMetadataVersionType
of the given document reference field. - getWeblink(String) - Method in interface com.veeva.vault.sdk.api.query.QueryWeblinkFieldResult
-
Retrieves the selected
QueryWeblink
for the givenfieldName
, if it exists. - getWithTargetFieldLookup() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves whether the request should account for
target_field_lookup
attributes during execution. - getWorkflow(String) - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionResponse
-
Given the workflow name, obtains the
AvailableWorkflowMetadata
. - getWorkflowActions() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowInstanceActionsResponse
-
Retrieves the available workflow actions for the requested workflow.
- getWorkflowConfiguration() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the
WorkflowConfiguration
for the workflow that the action is configured on. - getWorkflowId() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionResponse
-
If the user action was a Run Workflow user action, retrieves the workflow ID if it was successfully started.
- getWorkflowId() - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionResponse
-
If the user action was a Run Workflow user action, then retrieves the workflow id if it was successfully started.
- getWorkflowId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowActionResponse
-
Retrieves the workflow id.
- getWorkflowId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRequestExecutionContext
-
Gets the workflow ID.
- getWorkflowId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceResponse
-
Retrieves the workflow ID if it was successfully started.
- 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.
- getWorkflowInstance(WorkflowInstanceRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Retrieves a
WorkflowInstance
on the given workflow ID. - getWorkflowInstance(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionResponse
-
Given the workflow ID, obtains the
WorkflowInstance
. - getWorkflowInstances() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionResponse
-
Retrieve a list of
WorkflowInstance
. - getWorkflowInstances(WorkflowInstanceCollectionRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Retrieves a list of workflow instances on the given search options.
- getWorkflowItems() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the items in the workflow this action is executing against.
- getWorkflowItems() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemsResponse
-
Retrieves the items in the requested workflow.
- getWorkflowItems(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Retrieves a
WorkflowItemsResponse
containing the items in the active workflow this action is executing against. - getWorkflowItemType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItem
-
Retrieves the workflow item type.
- getWorkflowName() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadata
-
Returns the name of the workflow associated with this user action, if this is a workflow user action.
- getWorkflowName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadata
-
Returns the name of the workflow associated with this user action, if this is a workflow user action.
- getWorkflowName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRequestExecutionContext
-
Gets the workflow name.
- getWorkflowName() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataResponse
-
Retrieves the name of the workflow.
- getWorkflowOwnerId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRequestExecutionContext
-
Gets the workflow owner ID.
- getWorkflowParticipantGroups() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupResponse
-
Retrieves the workflow participant groups in the active requested workflow.
- getWorkflowParticipantGroups(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Retrieves a
WorkflowParticipantGroupResponse
containing workflow participant groups in the given active workflow. - getWorkflows() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionResponse
-
Retrieves the list of
AvailableWorkflowMetadata
. - getWorkflowStartMetadata(WorkflowStartMetadataRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowMetadataService
-
Retrieves the workflow start metadata on the given workflow name and list of documents or record IDs.
- getWorkflowType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowConfiguration
-
Retrieves the workflow type.
- Group - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve group related information.
- GROUP - Enum constant in enum class com.veeva.vault.sdk.api.job.JobOwnerType
-
The job owner is a group.
- GroupService - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve
GetGroupsResponse
and check user membership in group. - GroupType - Enum Class in com.veeva.vault.sdk.api.group
-
Valid values for group classifications.
H
- hasControllingField() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves whether the given picklist field has a controlling field.
- hasControllingField() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves whether the given reference field has a controlling field.
- hasError() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesResponse
-
Identifies if there was an error in any of the field rule evaluations.
- hasError() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Identifies if there was an error when evaluating this field rule.
- hasError() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesResponse
-
Indicates if there was an error when retrieving the integration rules.
- 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.
- hasFacetResponse() - Method in interface com.veeva.vault.sdk.api.query.QueryCountResponse
-
Checks whether the response contains a
QueryFacetResponse
. - hasFacetResponse() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResponse
-
Checks whether the response contains a
QueryFacetResponse
. - hasPicklistDependencies() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves whether the given picklist field has picklist dependencies.
- hasValueSet() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationField
-
Retrieves whether values for the given annotation field are restricted to specific values defined in a value set.
- hasValueSet() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkField
-
Retrieves whether values for the given annotation placemark field are restricted to specific values defined in a value set.
- hasValueSet() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceField
-
Retrieves whether values for the given annotation reference field are restricted to specific values defined in a value set.
- hasWarnings() - Method in interface com.veeva.vault.sdk.api.data.PositionalRecordId
-
Indicates the warning status of the given Record.
- HIDDEN_FIELDS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
List of selected fields hidden on this result row for the querying user.
- HIDDEN_SUBQUERIES - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
List of subqueries hidden on this result row for the querying user.
- HIGH_VOLUME - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Deprecated.as of 23R3.2, replaced by
ObjectMetadataDataStore.RAW
- HttpMethod - Enum Class 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 Class 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.
- HttpRequestContentType - Enum Class in com.veeva.vault.sdk.api.http
-
Supported values for the Content-Type header in an
HttpRequest
, which can be set usingHttpRequest.setContentType(com.veeva.vault.sdk.infrastructure.http.HttpRequestContentEnumType)
. - 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.
- HttpTokens - Interface in com.veeva.vault.sdk.api.http
-
Set of tokens built-in to
HttpService
that will be resolved forHttpRequest
s that have token resolution enabled. - HttpWebRequest - Interface in com.veeva.vault.sdk.api.http
-
A HttpRequest super interface that is required to be extended in sdk for different HttpRequest
- HttpWebRequest.Builder<B extends HttpWebRequest.Builder> - Interface in com.veeva.vault.sdk.api.http
I
- icon() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
Name identifying the icon displayed with the action label in the Vault UI Action Bar.
- icon() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Name identifying the icon displayed with the action label in the Vault UI Action Bar.
- ICON - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with icon return type.
- ICON - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type icon.
- ID - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of the ID object field.
- ID - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of the ID object field.
- ID - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type ID.
- ID - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of the ID object type field.
- ID - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type ID.
- idempotent() - Element in annotation interface com.veeva.vault.sdk.api.job.JobInfo
-
Indicates if the job is idempotent: If the job will produce the same outcome if it is run multiple times.
- IGNORE - Enum constant in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Specifies this field is never included in the JSON.
- IGNORE_ALL - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates no escaping is applied.
- IGNORE_BACKSLASH - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates backslashes are not escaped.
- IGNORE_DOUBLE_QUOTE - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates double quotes are not escaped.
- IGNORE_PARENTHESIS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates open and close parentheses are not escaped.
- IGNORE_SINGLE_QUOTE - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates single quotes are not escaped.
- IGNORE_WILDCARD - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Indicates wildcard characters are not escaped.
- 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.
- include() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedModelInfo
-
The default serialization behavior for this user-defined model.
- include() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedProperty
-
The serialization behavior of this user-defined property.
- includeLabels(boolean) - Method in interface com.veeva.vault.sdk.api.query.QueryFacetRequest.Builder
-
Indicates whether the
QueryFacetValue
s should include the labels for the values. - info(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs an INFO type message to the Debug Log and Runtime Log.
- info(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs the templated INFO type message to the Debug Log and Runtime 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 and Runtime Log.
- INFORMATION_UNAVAILABLE - Enum constant in enum class com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
- init(JobInitContext) - Method in interface com.veeva.vault.sdk.api.job.Job
-
Initializes the
JobInputSupplier
. - INITIATING_USER - Enum constant in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Indicates the user that initiated the request.
- INITIATING_USER - Enum constant in enum class com.veeva.vault.sdk.api.core.RequestContextUserType
-
Indicates the user that initiated the request (User at keyboard or system).
- INSTRUCTIONS - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- INSUFFICIENT_ACCESS - Enum constant in enum class com.veeva.vault.sdk.api.edl.MatchedDocumentErrorType
- IntegrationRule - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information related to an
IntegrationRule
. - IntegrationRuleError - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve the error type and message associated with an integration rule.
- IntegrationRuleQuery - Interface in com.veeva.vault.sdk.api.integration
-
Represents an integration rule query, which you can include in a VQL query string and submit through
HttpService
. - IntegrationRuleQuery.Builder - Interface in com.veeva.vault.sdk.api.integration
-
Creates an instance of
IntegrationRuleQuery
. - IntegrationRuleService - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve and evaluate integration rules.
- INVALID_DATA - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to invalid annotation data.
- INVALID_DATA - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordAttachmentBatchOperationErrorType
- INVALID_DATA - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordMergeOperationErrorType
-
Errors where the data from the request was invalid.
- INVALID_DATA - Enum constant in enum class com.veeva.vault.sdk.api.edl.MatchedDocumentErrorType
- INVALID_DATA - Enum constant in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Indicates the query item has an invalid format.
- INVALID_PLACEMARK - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to an issue with the annotation placemark, such as specifying a page, coordinate, or text index that does not exist on the document.
- INVALID_QUERY - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
The query request failed during VQL processing.
- INVALID_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to an issue with an annotation's references or referenced object records, such as specifying an anchor, record, or permalink that cannot be found.
- INVALID_REQUEST - Enum constant in enum class com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
The execution failed due to invalid values in the request.
- INVALID_USER_MENTION - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to the user mentions in the annotation comment.
- isActive() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the active status of the given object field.
- isActive() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the active status of the given object field.
- isActive() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Checks the active status of the given object.
- isActive() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves the active status of the given object field.
- isActive() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves the active status of the given object type.
- isActive() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the active status of the given document field.
- isActive() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
Retrieves the active status of the given document type.
- 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.integration.FieldRule
-
Determines whether this rule is active.
- isActive() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the activation status of this rule.
- isActive() - Method in interface com.veeva.vault.sdk.api.integration.QueryObjectRule
-
Determines whether this
Queryobjectrule
is active. - isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the active status of this document lifecycle.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadata
-
Retrieves the active status of this document lifecycle role.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadata
-
Retrieves the active status of this document lifecycle stage group.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadata
-
Retrieves the active status of this document lifecycle stage.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadata
-
Retrieves the active status of this document lifecycle state.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the active status of this object lifecycle.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadata
-
Retrieves the active status of this object lifecycle role.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the active status of this object lifecycle stage group.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the active status of this object lifecycle stage.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the active status of this object lifecycle state.
- isActive() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the active status of this object lifecycle state type.
- isActive() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
-
Determines if a picklist value is active or inactive.
- isAttachmentEnabled() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Checks whether attachments are enabled on this object.
- isCheckbox() - Method in interface com.veeva.vault.sdk.api.data.ObjectBooleanFieldMetadata
-
Retrieves whether the given Boolean field is a checkbox.
- isCopyField() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the copyable status of the given object field.
- isCopyField() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given field is a copy field.
- isDebugEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Checks if the Debug Log is enabled.
- isDefaultType() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadata
-
Retrieves whether the given object type is the default object type.
- isEditable() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the editable status of the given object field.
- isEditable() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves the editable status of the given object field.
- isEditable() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the editability of the given document field for the current user.
- isEncrypted() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the encryption status of the given object field.
- isEncrypted() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given field is encrypted.
- isErrorEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Checks if the Debug Log or Runtime Log is enabled.
- isExecutable() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionDetail
-
Retrieves whether the run as user has permission to execute the user action.
- isExecutable() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionDetail
-
Retrieves whether the run as user has permission to execute the user action.
- 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.
- isFacetable() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given object field is facetable.
- 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.
- isHidden() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadata
-
Retrieves the hidden status of this document lifecycle.
- isInfoEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Checks if the Debug Log or Runtime Log is enabled.
- isListColumn() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given object field is a list column.
- isLocalConnectionContextAllowed(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.connection.ConnectionService
-
Indicates whether local access is available for the provided
RequestContextUserType
. - isLocalHttpRequestAllowed(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Indicates whether local access is available for the provided
RequestContextUserType
. - isMigrationModeEnabled() - Method in interface com.veeva.vault.sdk.api.data.RecordTriggerContext
-
Retrieves the current context and checks whether Record Migration Mode is currently enabled.
- isMultiValue() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves whether the given picklist field is a multi-value field.
- isMultiValue() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves whether the parameter is a multi-value input.
- isObjectTypesEnabled() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Checks whether object types are enabled on this object.
- isOriginatedInThisProcess() - Method in exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
- isQueryable() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the queryability of the given document field for the current user.
- isReadOnly() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves whether the parameter is read only.
- isRecordAvailable() - Method in interface com.veeva.vault.sdk.api.query.QueryRecordPermissionResult
-
Checks if the querying user has object record read permissions for this record.
- isRecordCreatable() - Method in interface com.veeva.vault.sdk.api.query.QueryRecordPermissionResult
-
Checks if the querying user has object record create permissions for this record.
- isRecordDeletable() - Method in interface com.veeva.vault.sdk.api.query.QueryRecordPermissionResult
-
Checks if the querying user has object record delete permissions for this record.
- isRecordEditable() - Method in interface com.veeva.vault.sdk.api.query.QueryRecordPermissionResult
-
Checks if the querying user has object record edit permissions for this record.
- isRequired() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the required status of the given object field.
- isRequired() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given field is a required field.
- isRequired() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadata
-
Retrieves whether the given object type field is a required field.
- isRequired() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the required status of the given document field.
- isRequired() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParameterMetadata
-
Retrieves whether the parameter is required to start the workflow.
- isSearchable() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves whether the given lookup field is searchable.
- isSecureRelationship() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieves whether the document reference field is a secure relationship.
- isSecureRelationship() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve whether the parent reference field is a secure relationship.
- isSecureRelationship() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieves whether the reference field is a secure relationship.
- isShared() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
Retrieves the shared status of the given document field.
- isStateRequired() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the required status for this state type.
- isSystemManaged() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationField
-
Retrieves whether the given annotation field is system-managed.
- isSystemManaged() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkField
-
Returns whether the annotation placemark field is system-managed.
- isSystemManaged() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceField
-
Returns whether the annotation reference field is system-managed.
- isSystemManaged() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Checks whether the object's records are system-managed.
- isSystemManaged() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
Retrieves whether the given text field is a system-managed field.
- isTruncatedList() - Method in interface com.veeva.vault.sdk.api.query.QueryFacetResult
-
Checks whether the result has been truncated.
- isUnique() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.Retrieves the unique status of the given object field.
- isUnique() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves whether the given field is a unique field.
- 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.
- isViewable() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionDetail
-
Retrieves whether the run as user has permission to view the user action.
- isViewable() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionDetail
-
Retrieves whether the run as user has permission to view the user action.
- isVisible() - Element in annotation interface com.veeva.vault.sdk.api.job.JobInfo
-
Determines if a job will appear in the Scheduled, Running, and History tables in the Job Admin UI.
- isWarnEnabled() - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Checks if the Debug Log or Runtime Log is enabled.
- ITEM_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Indicates the query item is missing from source.
- ITEM_PROCESSING_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Indicates an error during item processing within the message.
- ItemErrorType - Enum Class in com.veeva.vault.sdk.api.integration
-
Valid integration and field rule item error types.
J
- Job - Interface in com.veeva.vault.sdk.api.job
-
Invoked by
JobService
to start a Job with the Vault Java SDK. - JOB_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
The job is not currently running or does not exist.
- JobCancelOperation<T> - Interface in com.veeva.vault.sdk.api.job
-
A sequence of instructions that can be chained together, building a job cancellation operation which can be executed with
JobCancelOperation.execute()
. - JobCancelOperationError - Interface in com.veeva.vault.sdk.api.job
-
Represents an unsuccessful attempt to cancel a job.
- JobCancelOperationErrorType - Enum Class in com.veeva.vault.sdk.api.job
-
Valid values for error types encountered during job cancellation.
- JobCancelRequest - Interface in com.veeva.vault.sdk.api.job
-
Represents a job cancellation request which can be submitted through
JobService.cancel(JobCancelRequest)
. - JobCancelRequest.Builder - Interface in com.veeva.vault.sdk.api.job
-
Creates a new instance of
JobCancelRequest
. - JobCancelResponse - Interface in com.veeva.vault.sdk.api.job
-
Represents a successful attempt to cancel a job.
- JobCompletionContext - Interface in com.veeva.vault.sdk.api.job
-
Context given to
Job
's complete methods. - JobContext - Interface in com.veeva.vault.sdk.api.job
-
Contains contextual information about the current job.
- JobInfo - Annotation Interface in com.veeva.vault.sdk.api.job
-
Indicates a class is a job processor.
- JobInitContext - Interface in com.veeva.vault.sdk.api.job
-
Context given to
Job.init(JobInitContext)
. - JobInputSupplier - Interface in com.veeva.vault.sdk.api.job
-
An object returned by
Job.init(com.veeva.vault.sdk.api.job.JobInitContext)
which allows the job to be chunked and processed correctly. - JobItem - Interface in com.veeva.vault.sdk.api.job
-
Contains data about a single item in a
Job
. - JobLogger - Interface in com.veeva.vault.sdk.api.job
-
Allows logging to the job log file.
- JobOwner - Interface in com.veeva.vault.sdk.api.job
-
Contains information about a job's owner.
- JobOwnerType - Enum Class in com.veeva.vault.sdk.api.job
-
Valid values for the job owner type, either a single user or a group.
- JobParameters - Interface in com.veeva.vault.sdk.api.job
-
Provides methods to set values for job parameters.
- JobParamValue - Interface in com.veeva.vault.sdk.api.job
-
An interface to store data in a job context.
- JobParamValueType<T> - Interface in com.veeva.vault.sdk.api.job
-
Type of data supported by the Vault Java SDK for job parameters set on
JobParameters
when invoking a job throughJobService
. - JobProcessContext - Interface in com.veeva.vault.sdk.api.job
-
Context given to
Job.process(JobProcessContext)
. - JobResult - Interface in com.veeva.vault.sdk.api.job
-
Contains information about a
Job
's task results. - JobRunResult - Interface in com.veeva.vault.sdk.api.job
-
Contains information about a job started through
JobService.runJob(JobParameters)
. - JobService - Interface in com.veeva.vault.sdk.api.job
-
Service interface to run jobs with specified parameters.
- JobTask - Interface in com.veeva.vault.sdk.api.job
-
Provides methods to get task information.
- JobValue - Interface in com.veeva.vault.sdk.api.job
-
An interface to store data in a job context.
- JobValueType<T> - Interface in com.veeva.vault.sdk.api.job
-
Type of data supported by the Vault Java SDK for parameters setting via
Job.init(JobInitContext)
andJob.process(JobProcessContext)
. - 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 - Interface in com.veeva.vault.sdk.api.json
-
Represents immutable JSON.
- JSONDATA - Static variable in interface com.veeva.vault.sdk.api.http.HttpResponseBodyValueType
-
JSON response body type.
- 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. - JsonProperty - Interface in com.veeva.vault.sdk.api.json
-
Represents a property of a
JsonObject
. - 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
- label() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
UI label of the document action in Vault.
- label() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
UI label of the action in Vault.
- label() - Element in annotation interface com.veeva.vault.sdk.api.email.EmailProcessorInfo
-
The value displayed to Admins in the Vault UI when selecting an
EmailProcessor
while setting up an Inbound Email Address record. - label() - Element in annotation interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionInfo
-
UI label of the action in Vault.
- LATEST_FROM_ALLVERSIONS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryTargetOption
-
Indicates the latest matching version should be returned, even if it is not the absolute latest version.
- LATEST_STEADY_STATE_VERSION - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
This is a representation of a latest steady state document version field.
- LATEST_VERSION - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
This is a representation of a latest document version field.
- LF - Enum constant in enum class com.veeva.vault.sdk.api.csv.LineEnding
-
Line ending that only consists of a line feed (LF).
- lifecycle() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
The lifecycle this document action supports, for example,
general_lifecycle__c
. - LIFECYCLE_ENTRY_ACTION - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action supports use as an entry action and event action.
- LIFECYCLE_STATE - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Deprecated.as of 19R2.2, replaced by OBJECT_LIFECYCLE_STATE and DOCUMENT_LIFECYCLE_STATE
- LifecycleRole - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve role information for a document or object lifecycle.
- LineEnding - Enum Class in com.veeva.vault.sdk.api.csv
-
Line endings supported while reading/writing CSVs.
- LINK - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with link return type.
- LINK - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type link.
- LOCAL - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Represents the local currency type for currency formula fields.
- locate(Class<T>) - Static method in class com.veeva.vault.sdk.api.core.ServiceLocator
-
Locates the requested
Service
. - log(String) - Method in interface com.veeva.vault.sdk.api.job.JobLogger
-
Writes a String to the job log file.
- logResourceUsage(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs current resource usage for elapsed time (milliseconds), memory (bytes), and CPU time (nanoseconds) to the Debug Log.
- LogService - Interface in com.veeva.vault.sdk.api.core
-
Send messages to the Vault Java SDK Logs, available in Admin > Logs > Vault Java SDK Logs.
- LONGTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a long text object field.
- LONGTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a long text object field.
- LONGTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type long text.
- LONGTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a long text object type field.
- LONGTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type long text.
- LOOKUP - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a lookup object field.
- LOOKUP - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a lookup object field.
- LOOKUP - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a lookup object type field.
- LOOKUP - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a lookup document field.
M
- MANAGERS_GROUP - Enum constant in enum class com.veeva.vault.sdk.api.group.GroupType
-
Groups created and populated automatically by Vaults when managers group feature enabled.
- MatchedDocumentError - Interface in com.veeva.vault.sdk.api.edl
-
Represents an error that occurred while processing one provided matched document in the batch request.
- MatchedDocumentErrorResult - Interface in com.veeva.vault.sdk.api.edl
-
Provides data about the error included in a
MatchedDocumentService
batch operation response, including the error message and type. - MatchedDocumentErrorType - Enum Class in com.veeva.vault.sdk.api.edl
-
Valid values for error types when using methods in
MatchedDocumentService
. - MatchedDocumentResult - Interface in com.veeva.vault.sdk.api.edl
-
Contains information about one processed matched document, including the EDL Item ID and document version ID.
- MatchedDocumentService - Interface in com.veeva.vault.sdk.api.edl
-
Provides methods to batch save and remove automatically and manually matched documents.
- MatchedDocumentServiceBatchOperation - Interface in com.veeva.vault.sdk.api.edl
-
Custom batch operation response interface for the
MatchedDocumentService
batch methods. - MatchedDocumentSuccess - Interface in com.veeva.vault.sdk.api.edl
-
Represents the result of successfully processing one provided matched document in the batch request.
- 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.
- matchOnExternalId() - Method in interface com.veeva.vault.sdk.api.data.BatchDeleteRecordAttachmentRequest.Builder
-
Optional: Indicates whether the external ID or attachment ID will be used to identify the attachment record.
- matchOnExternalId() - Method in interface com.veeva.vault.sdk.api.data.BatchSaveRecordAttachmentRequest.Builder
-
Optional: Indicates whether the external ID or attachment ID will be used to identify the attachment record.
- mergeRecords(RecordMergeRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Starts a batch record merge operation job.
- Message - Interface in com.veeva.vault.sdk.api.queue
-
Provides methods to update the content of a Spark message.
- MESSAGE_PROCESSING_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Indicates an error during message processing.
- 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.
- MessageDeliveryError - Interface in com.veeva.vault.sdk.api.queue
-
Provides methods to retrieve the failure type and error message of the failed Spark message delivery.
- MessageDeliveryErrorType - Enum Class in com.veeva.vault.sdk.api.queue
-
Error types that may occur when sending a Spark message.
- MessageDeliveryEventHandler - Interface in com.veeva.vault.sdk.api.queue
-
Provides methods to override default behavior for handling failed Spark message deliveries.
- MessageDeliveryEventHandlerContext - Interface in com.veeva.vault.sdk.api.queue
-
Retrieves the context and delivery error of the failed Spark message delivery.
- MessageDeliveryEventHandlerInfo - Annotation Interface in com.veeva.vault.sdk.api.queue
-
Indicates a class is a
MessageDeliveryEventHandler
. - MessageDeliveryEventHandlerSendContext - Interface in com.veeva.vault.sdk.api.queue
-
Retrieves the context and sets tokens for the outbound Spark message.
- MessageErrorType - Enum Class in com.veeva.vault.sdk.api.integration
-
Valid integration and field rule message error types.
- MessageProcessor - Interface in com.veeva.vault.sdk.api.queue
-
Invoked to process a message received by an inbound queue.
- MessageProcessorInfo - Annotation Interface in com.veeva.vault.sdk.api.queue
-
Indicates a class is a
MessageProcessor
. - migrateDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Creates new document-versions for existing documents.
N
- name() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
Deprecated.as of 18R3. Code names are now derived from the name of the top-level class
- name() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Deprecated.as of 18R3. Code names are now derived from the name of the top-level class
- name() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedClassInfo
-
Deprecated.as of 18R3. Code names are now derived from the name of the top-level class.
- name() - Element in annotation interface com.veeva.vault.sdk.api.core.UserDefinedProperty
-
The name of this user-defined property.
- name() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordTriggerInfo
-
Deprecated.as of 18R3. Code names are now derived from the name of the top-level class.
- NEW_VERSION - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordAttachmentPositionResultType
-
A new version of the attachment with the same name but different checksum is created.
- NEW_WINDOW - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryWeblinkTarget
-
Link opens in a new tab or window.
- newAnnotationBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
Annotation.Builder
. - newAnnotationBuilderWithId(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
Annotation.Builder
for the specified unique annotation ID. - newAvailableWorkflowMetadataCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowMetadataService
- newBatchDeleteRecordAttachmentRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Returns a builder of BatchDeleteRecordAttachmentRequest
- newBatchDeleteRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationBatchDeleteRequest.Builder
. - newBatchRemoveMatchedDocumentsRequestBuilder() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Creates a new
BatchRemoveMatchedDocumentsRequest.Builder
. - newBatchSaveMatchedDocumentsRequestBuilder() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Creates a new
BatchSaveMatchedDocumentsRequest.Builder
. - newBatchSaveRecordAttachmentRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Returns a builder of BatchSaveRecordAttachmentRequest
- newBatchSaveRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationBatchSaveRequest.Builder
. - newCancelJobRequestBuilder() - Method in interface com.veeva.vault.sdk.api.job.JobService
-
Creates a new
JobCancelRequest.Builder
. - newCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleMetadataCollectionRequest.Builder
. - newConnectionContext(String, ConnectionUser) - Method in interface com.veeva.vault.sdk.api.connection.ConnectionService
- 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. - newDeleteRecordAttachmentBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
- newDocument() - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a new, empty
DocumentVersion
. - newDocumentAttachment(FileReference, String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
- newDocumentAttachmentFileReference(ConnectionContext, String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentAttachmentFileReference
and sets the ID. - newDocumentFieldCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Creates a
DocumentFieldCollectionRequest.Builder
. - newDocumentFieldFilterBuilder() - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Creates a
DocumentFieldFilter.Builder
. - newDocumentRendition(FileReference, String, String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
- newDocumentRenditionFileReference(ConnectionContext, String, String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentRenditionFileReference
and sets the rendition type, ID, major and minor version. - newDocumentRoleUpdate(String, DocumentVersion) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
Creates a
DocumentRoleUpdate
which can be submitted toDocumentRoleService.batchUpdateDocumentRoles(List)
to update document roles on a particular document. - newDocumentSourceFileReference(ConnectionContext, String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentSourceFileReference
and sets the ID, major and minor version. - newDocumentTypeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
Creates a
DocumentTypeRequest.Builder
. - newDocumentVersion(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Deprecated.as of 19R3.5, replaced by
DocumentService.newVersionWithId(String)
- newDocumentVersionUserActionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
- newDocumentWithId(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentVersion
with the givenid
and sets the version to the latest version of the document. - newEvaluateFieldRulesRequestBuilder() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Begin a request to evaluate field rule.
- newExecutionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionService
- newExecutionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionService
-
Creates a
UserActionExecutionRequest.Builder
. - newFieldCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Deprecated.as of 23R1.3, replaced by
ObjectMetadataService.newFieldCollectionRequestBuilder()
- newFieldFilterBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionRequest.Builder
-
Deprecated.Creates an instance of
ObjectFieldFilter.Builder
. - newFieldRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationFieldRequest.Builder
. - newFieldRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Deprecated.as of 23R1.3, replaced by
ObjectMetadataService.newFieldCollectionRequestBuilder()
- newGetIntegrationRulesRequestBuilder() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Begin a request to get integration rules.
- newHttpRequest(String) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 24R1.1, replaced by {@link #newHttpRequestBuilder().withConnectionName()}.
- newHttpRequestBuilder() - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Create a
FormHttpRequest.Builder
forFormHttpRequest
- newInputParameterMetadataRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
- newIntegrationRuleQueryBuilder() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Creates an
IntegrationRuleQuery.Builder
. - newJobInput(String) - Method in interface com.veeva.vault.sdk.api.job.JobInitContext
-
Allows a VQL query to be used as a Job input.
- newJobInput(List<JobItem>) - Method in interface com.veeva.vault.sdk.api.job.JobInitContext
-
Allows a List of
JobItem
s to be used as input to a job. - newJobItem() - Method in interface com.veeva.vault.sdk.api.job.JobInitContext
-
Retrieves a new
JobItem
object. - newJobParameters(String) - Method in interface com.veeva.vault.sdk.api.job.JobService
-
Retrieves 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
-
Retrieves a new
JsonArrayBuilder
. - newJsonArrayBuilder(JsonArray) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Retrieves a new
JsonArrayBuilder
with all the values of the provided JsonArray. - newJsonObjectBuilder() - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Retrieves a new
JsonObjectBuilder
. - newJsonObjectBuilder(JsonObject) - Method in interface com.veeva.vault.sdk.api.json.JsonService
-
Retrieves a new
JsonObjectBuilder
with all the properties of the provided JsonObject. - newLifecycleRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Creates a
DocumentLifecycleMetadataRequest.Builder
. - newLifecycleUserActionMetadataRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
-
Creates an
ObjectLifecycleUserActionMetadataRequest.Builder
. - 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.
- newLocalConnectionContext() - Method in interface com.veeva.vault.sdk.api.connection.ConnectionService
-
Deprecated.as of 22R3.4, replaced by
ConnectionService.newLocalConnectionContext(RequestContextUserType)
. - newLocalConnectionContext(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.connection.ConnectionService
-
Initializes a local
ConnectionContext
for the local Vault and for the user type specified by the requestContextUserType. - newLocalHttpRequest() - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 22R3.4, replaced by
HttpService.newLocalHttpRequest(RequestContextUserType)
. - newLocalHttpRequest(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 24R1.1, replaced by {@link #newHttpRequestBuilder().withLocalConnection(RequestContextUserType}.
- 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 withQueueService.putMessage(Message)
, in order to set message attributes and items. - newMessage(String, List<String>) - Method in interface com.veeva.vault.sdk.api.queue.QueueService
-
Creates a new instance of a
Message
to be sent on a queue withQueueService.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. - newObjectFieldMetadataCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Creates an
ObjectFieldMetadataCollectionRequest.Builder
. - newObjectPicklistDependencyRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Creates an
ObjectPicklistDependencyRequest.Builder
. - newObjectRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Creates an
ObjectMetadataRequest.Builder
. - newObjectTypeFieldMetadataCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Creates an
ObjectTypeFieldMetadataCollectionRequest.Builder
. - newObjectTypeMetadataCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
Creates an
ObjectTypeMetadataCollectionRequest.Builder
. - newParticipantGroupUpdate(WorkflowParticipantGroup) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a new
WorkflowParticipantGroupUpdate
to allow membership updates to a participant group. - newPicklistRequestBuilder() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
Retrieves a
PicklistRequest.Builder
object, which can be used to build aPicklistRequest
. - newPlacemarkBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationPlacemark.Builder
. - newPlacemarkFieldRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationPlacemarkFieldRequest.Builder
. - newPlacemarkTypeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationPlacemarkTypeRequest.Builder
. - newPlacemarkValueSetRequestBuilder(AnnotationPlacemarkValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationPlacemarkValueSetRequest.Builder
. - newPostExecutionUserActionUIBehaviorBuilder() - Method in interface com.veeva.vault.sdk.api.action.UserActionUIService
-
Retrieve a
PostExecutionUserActionUIBehavior.Builder
to set UI behavior for a user action. - newPreExecutionUserActionUIBehaviorBuilder() - Method in interface com.veeva.vault.sdk.api.action.UserActionUIService
-
Retrieve a
PreExecutionUserActionUIBehavior.Builder
to set UI behavior for a user action. - newQueryBuilder() - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Retrieves a
Query.Builder
. - newQueryBuilderFromQuery(Query) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Creates a
Query.Builder
based on aQuery
. - newQueryCountRequestBuilder() - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Retrieves a
QueryCountRequest.Builder
. - newQueryExecutionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Retrieves a
QueryExecutionRequest.Builder
. - newQueryFacetRequestBuilder() - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Retrieves a
QueryFacetRequest.Builder
. - newQueryValidationRequestBuilder() - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Retrieves a
QueryValidationRequest.Builder
. - newReadAnnotationRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationReadRequest.Builder
. - newReadReplyRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationReplyReadRequest.Builder
. - newRecord(String) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Instantiates a
Record
of the specified type but does not set theid
. - newRecordAttachmentFileReference(RecordAttachmentFileReferenceRequest) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Instantiates a
RecordAttachmentFileReference
. - newRecordAttachmentFileReferenceRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Creates a
RecordAttachmentFileReferenceRequest.Builder
. - newRecordBatchDeleteRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Creates a
RecordBatchDeleteRequest.Builder
. - newRecordBatchSaveRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Creates a
RecordBatchSaveRequest.Builder
. - newRecordDisplayRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayService
-
Creates a
RecordDisplayRequest.Builder
. - newRecordLifecycleCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newRecordLifecycleRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectRecordLifecycleMetadataRequest.Builder
. - newRecordLifecycleUserActionMetadataRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateUserActionMetadataService
- newRecordMergeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Returns a builder of RecordMergeRequest
- newRecordMergeSetInputBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Returns a builder of RecordMergeSetInput
- 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 theid
. - newReferenceBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Creates a new
AnnotationReference.Builder
. - newReferenceFieldRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationReferenceFieldRequest.Builder
. - newReferenceTypeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationReferenceTypeRequest.Builder
. - newReferenceValueSetRequestBuilder(AnnotationReferenceValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationReferenceValueSetRequest.Builder
. - newRemoveMatchedDocumentBuilder() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Creates a new
RemoveMatchedDocument.Builder
. - newRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleMetadataRequest.Builder
. - newRoleCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newRoleRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
-
Creates a
DocumentLifecycleRoleMetadataRequest.Builder
. - newRoleRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleRoleMetadataRequest.Builder
. - 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 specifiedCsvBuilder
. - newSaveMatchedDocumentBuilder() - Method in interface com.veeva.vault.sdk.api.edl.MatchedDocumentService
-
Creates a new
SaveMatchedDocument.Builder
. - newSaveRecordAttachmentBuilder() - Method in interface com.veeva.vault.sdk.api.data.RecordService
- 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.
- newStageCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newStageGroupCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newStageGroupRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
- newStageGroupRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleStageGroupMetadataRequest.Builder
. - newStageRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
- newStageRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleStageMetadataRequest.Builder
. - newStartWorkflowInputParameterBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionService
- newStateCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newStateRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataService
- newStateRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleStateMetadataRequest.Builder
. - newStateTypeCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
- newStateTypeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
Creates an
ObjectLifecycleStateTypeMetadataRequest.Builder
. - newTokenRequestBuilder() - Method in interface com.veeva.vault.sdk.api.token.TokenService
-
Returns a new builder for a
TokenRequest
. - newTranslationsReadRequestBuilder() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationService
-
Creates a new instance of
TranslationsReadRequestBuilder
. - newTypeRequestBuilder() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationTypeRequest.Builder
. - newUserActionExecutionBannerBuilder() - Method in interface com.veeva.vault.sdk.api.action.UserActionUIService
-
Retrieve a new instance of
UserActionExecutionBanner.Builder
to build aUserActionExecutionBanner
. - newUserActionExecutionDialogBuilder() - Method in interface com.veeva.vault.sdk.api.action.UserActionUIService
-
Retrieve a new instance of
UserActionExecutionDialog.Builder
to build aUserActionExecutionDialog
. - newUserActionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
- newUserDefinedModel(Class<U>) - Method in interface com.veeva.vault.sdk.api.core.UserDefinedModelService
-
Returns a new empty UserDefinedModel instance of type specified.
- newUserInputRequestBuilder() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateUserActionMetadataService
- newValueSetRequestBuilder(AnnotationValueType<T>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationMetadataService
-
Creates a new
AnnotationValueSetRequest.Builder
. - newVersion(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentVersion
and sets the document ID. - newVersionWithId(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Instantiates a
DocumentVersion
and sets the ID, major version, and minor version. - newWorkflowAddParticipantsRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowAddParticipantsRequest.Builder
. - newWorkflowCancelRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowCancelRequest.Builder
. - newWorkflowInstanceCollectionRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates an
WorkflowInstanceCollectionRequest.Builder
. - newWorkflowInstanceRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowInstanceRequest.Builder
. - newWorkflowParticipantGroupInputParameterBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
- newWorkflowParticipantInputParameterBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowParticipantInputParameter.Builder
. - newWorkflowRemoveItemsRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowRemoveItemsRequest.Builder
. - newWorkflowReplaceOwnerRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowReplaceOwnerRequest.Builder
. - newWorkflowStartMetadataRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowMetadataService
-
Creates a
WorkflowStartMetadataRequest.Builder
. - newWorkflowStartRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowStartInstanceRequest.Builder
. - newWorkflowTaskQueryParameters() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskService
-
Creates a new
WorkflowTaskQueryParameters
to filter tasks by. - newWorkflowUpdateDueDateRequestBuilder() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowUpdateDueDateRequest.Builder
. - 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. - NON_NULL - Enum constant in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Specifies this field is included in the JSON only when not null.
- NOT_OK_HTTP_STATUS_CODE - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Indicates an HTTP status code other than success (200).
- NotificationMessage - Interface in com.veeva.vault.sdk.api.notification
-
Set the subject, message, and text to use in a notification.
- NotificationMode - Enum Class in com.veeva.vault.sdk.api.notification
-
Valid methods to send 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.
- NULL - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldMissingValueBehaviorType
-
- Formula will return null if operands contains blank fields
- Special case: blank fields will be skipped (eg. - NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a number object field.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a number object field.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with number return type.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type number.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a number object type field.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type number.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type number.
- NUMBER - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a number document field.
- NUMBER - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueType
-
Used by fields with number values.
- NUMBER - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationValueType
-
Used by fields with number values.
- 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.job.JobParamValueType
-
Maps to the "Number" field type in Vault.
- NUMBER - Static variable in interface com.veeva.vault.sdk.api.job.JobValueType
-
Maps to the "Number" field type in Vault.
- 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.
- NUMBER - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "Number" field type input.
- NUMBER_1 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_10 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_2 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_3 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_4 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_5 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_6 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_7 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_8 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_9 - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- NUMBER_LIST - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueType
-
Represents a list of number values.
O
- object() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Indicates the Vault object this action supports, for example,
product__v
. - object() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordMergeEventHandlerInfo
-
Name of the Vault object, for example, account__v.
- object() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordTriggerInfo
-
Name of the Vault object, for example,
site__v
. - object() - Element in annotation interface com.veeva.vault.sdk.api.role.RecordRoleTriggerInfo
-
Name of the Vault object, for example,
site__v
. - object() - Element in annotation interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionInfo
-
Indicates the object this action supports.
- OBJECT - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- OBJECT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowType
-
Object Workflow
- OBJECT - Static variable in interface com.veeva.vault.sdk.api.json.JsonValueType
- OBJECT_FIELD - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- OBJECT_LIFECYCLE_STATE - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of an object reference object field.
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of an object reference object field.
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type object reference.
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of an object reference object type field.
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type object reference.
- OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of an object reference document field.
- ObjectBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on Boolean fields.
- ObjectComponentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on component fields.
- ObjectCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on currency fields.
- ObjectDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on date fields.
- ObjectDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on DateTime fields.
- ObjectDocumentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on document reference fields.
- ObjectDocumentReferenceFieldMetadataVersionType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible types for an
ObjectDocumentReferenceFieldMetadata
. - ObjectField - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.getField(ObjectFieldRequest)
- ObjectFieldCollectionRequest - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.newFieldCollectionRequestBuilder()
- ObjectFieldCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.Creates an instance of
ObjectFieldCollectionRequest
. - ObjectFieldCollectionResponse - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.getFields(ObjectFieldCollectionRequest)
- ObjectFieldFilter - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.newFieldCollectionRequestBuilder()
- ObjectFieldFilter.Builder - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.Creates an instance of
ObjectFieldFilter
. - ObjectFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on the specified object field.
- ObjectFieldMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.data
-
Retrieves a List of all fields that the current user has permission to view in the
ObjectFieldMetadata
once a request is built for the given object. - ObjectFieldMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.data
- ObjectFieldMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.data
-
Holds an
ObjectFieldMetadata
collection. - ObjectFieldMetadataType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of the possible object field types.
- ObjectFieldRequest - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.newFieldRequestBuilder()
- ObjectFieldRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.newFieldRequestBuilder()
- ObjectFieldType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible object field types.
- ObjectFormulaBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on Boolean formula fields.
- ObjectFormulaCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on currency formula fields.
- ObjectFormulaCurrencyFieldMetadataReturnType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible currency types for currency formula fields.
- ObjectFormulaDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on date formula fields.
- ObjectFormulaDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on DateTime formula fields.
- ObjectFormulaFieldExpressionMetadata - Interface in com.veeva.vault.sdk.api.data
-
A container for a formula field expression.
- ObjectFormulaFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on formula fields.
- ObjectFormulaFieldMissingValueBehaviorType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible missing field behavior types for a formula field.
- ObjectFormulaFieldType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible return types for a formula field.
- ObjectFormulaFieldTypeMetadata - Interface in com.veeva.vault.sdk.api.data
-
A representation of a typed formula field.
- ObjectFormulaIconFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on icon formula fields.
- ObjectFormulaLinkFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on link formula fields.
- ObjectFormulaNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on number formula fields.
- ObjectFormulaTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on text formula fields.
- ObjectIdFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on ID fields.
- ObjectLifecycleMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle.
- ObjectLifecycleMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycles in the format of
ObjectLifecycleMetadata
collection. - ObjectLifecycleMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleMetadataCollectionRequest
. - ObjectLifecycleMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleMetadata
collection. - ObjectLifecycleMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle in the format of
ObjectLifecycleMetadata
. - ObjectLifecycleMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleMetadataRequest
. - ObjectLifecycleMetadataService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve object lifecycle, state, state type, stage group, and stage metadata.
- ObjectLifecycleRoleMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle role.
- ObjectLifecycleRoleMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycle roles in the format of
ObjectLifecycleRoleMetadata
collection. - ObjectLifecycleRoleMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleRoleMetadataCollectionRequest
. - ObjectLifecycleRoleMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleRoleMetadata
collection. - ObjectLifecycleRoleMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle role in the format of
ObjectLifecycleRoleMetadata
. - ObjectLifecycleRoleMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleRoleMetadataRequest
. - ObjectLifecycleStageGroupMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle stage group.
- ObjectLifecycleStageGroupMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycle stage groups in the format of
ObjectLifecycleStageGroupMetadata
collection. - ObjectLifecycleStageGroupMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStageGroupMetadataCollectionRequest
. - ObjectLifecycleStageGroupMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleStageGroupMetadata
collection. - ObjectLifecycleStageGroupMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle stage group in the format of
ObjectLifecycleStageGroupMetadata
. - ObjectLifecycleStageGroupMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStageGroupMetadataRequest
. - ObjectLifecycleStageMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle stage.
- ObjectLifecycleStageMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycle stages in the format of
ObjectLifecycleStageMetadata
collection. - ObjectLifecycleStageMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStageMetadataCollectionRequest
. - ObjectLifecycleStageMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleStageMetadata
collection. - ObjectLifecycleStageMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle stage in the format of
ObjectLifecycleStageMetadata
. - ObjectLifecycleStageMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStageMetadataRequest
. - ObjectLifecycleStateMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle state.
- ObjectLifecycleStateMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycle states in the format of
ObjectLifecycleStateMetadata
collection. - ObjectLifecycleStateMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStateMetadataCollectionRequest
. - ObjectLifecycleStateMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleStateMetadata
collection. - ObjectLifecycleStateMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle state in the format of
ObjectLifecycleStateMetadata
. - ObjectLifecycleStateMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStateMetadataRequest
. - ObjectLifecycleStateTypeMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle state type.
- ObjectLifecycleStateTypeMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve multiple object lifecycle state types in the format of
ObjectLifecycleStateTypeMetadata
collection. - ObjectLifecycleStateTypeMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStateTypeMetadataCollectionRequest
. - ObjectLifecycleStateTypeMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleStateTypeMetadata
collection. - ObjectLifecycleStateTypeMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve a single object lifecycle state type in the format of
ObjectLifecycleStateTypeMetadata
. - ObjectLifecycleStateTypeMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectLifecycleStateTypeMetadataRequest
. - ObjectLifecycleStateUserActionMetadataService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata about an object lifecycle user action.
- ObjectLifecycleStateUserActionService - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to execute an object lifecycle user action.
- ObjectLifecycleUserActionCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectLifecycleUserActionMetadata
collection. - ObjectLifecycleUserActionInputParameterMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object action's input object.
- ObjectLifecycleUserActionInputParameterMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Representation of a request to retrieve metadata about user action input parameters, in the format of
ObjectLifecycleUserActionInputParameterMetadata
. - ObjectLifecycleUserActionInputParameterMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
- ObjectLifecycleUserActionMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve metadata fields for a specific object lifecycle user action.
- ObjectLifecycleUserActionMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Representation of a request to retrieve metadata about user actions, in the format of
ObjectRecordLifecycleUserActionCollectionResponse
. - ObjectLifecycleUserActionMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
- ObjectLongTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on long text fields.
- ObjectLookupBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on Boolean lookup fields.
- ObjectLookupComponentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on component lookup fields.
- ObjectLookupCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on currency lookup fields.
- ObjectLookupDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on date lookup fields.
- ObjectLookupDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on DateTime lookup fields.
- ObjectLookupFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on lookup fields.
- ObjectLookupFieldType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible field types for a lookup field.
- ObjectLookupFieldTypeMetadata - Interface in com.veeva.vault.sdk.api.data
-
A representation of a typed lookup field.
- ObjectLookupIdFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on ID lookup fields.
- ObjectLookupLongTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on long text lookup fields.
- ObjectLookupNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on number lookup fields.
- ObjectLookupObjectReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on object reference lookup fields.
- ObjectLookupParentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on parent reference lookup fields.
- ObjectLookupPicklistFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on picklist lookup fields.
- ObjectLookupRichTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on rich text lookup fields.
- ObjectLookupTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on text lookup fields.
- ObjectMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata for the specified object.
- ObjectMetadataDataStore - Enum Class in com.veeva.vault.sdk.api.data
-
Represents the data store type of an object.
- ObjectMetadataJoinType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible join types for objects.
- ObjectMetadataRequest - Interface in com.veeva.vault.sdk.api.data
-
Retrieves an instance of
ObjectMetadata
to build the request for retrieving object metadata. - ObjectMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
ObjectMetadataRequest
. - ObjectMetadataService - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve object and object-field metadata.
- ObjectNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on number fields.
- ObjectParentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on parent reference fields.
- ObjectPicklistDependency - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve object picklist dependency metadata.
- ObjectPicklistDependencyRequest - Interface in com.veeva.vault.sdk.api.data
-
Retrieves an instance of
ObjectPicklistDependency
to build the request for retrieving object picklist dependency metadata. - ObjectPicklistDependencyRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
ObjectPicklistDependencyRequest
. - ObjectPicklistDependencyResponse - Interface in com.veeva.vault.sdk.api.data
-
Holds an
ObjectPicklistDependency
collection. - ObjectPicklistFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on picklist fields.
- ObjectRecordLifecycleMetadata - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to retrieve object lifecycle metadata fields for a specific object record.
- ObjectRecordLifecycleMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve the object lifecycle metadata fields of multiple object records in the format of
ObjectRecordLifecycleMetadata
collection. - ObjectRecordLifecycleMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectRecordLifecycleMetadataCollectionRequest
. - ObjectRecordLifecycleMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectRecordLifecycleMetadata
collection. - ObjectRecordLifecycleMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents a request to retrieve the object lifecycle metadata fields of a single object record in the format of
ObjectRecordLifecycleMetadata
. - ObjectRecordLifecycleMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
-
Creates an instance of
ObjectRecordLifecycleMetadataRequest
. - ObjectRecordLifecycleUserActionCollectionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Holds an
ObjectRecordLifecycleUserActionDetail
collection. - ObjectRecordLifecycleUserActionDetail - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents the metadata associated with a lifecycle user action for a particular record.
- ObjectRecordLifecycleUserActionMetadataRequest - Interface in com.veeva.vault.sdk.api.lifecycle
- ObjectRecordLifecycleUserActionMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
- ObjectReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on reference fields.
- ObjectReferenceFieldMetadataDeleteType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible delete types for reference fields.
- ObjectRichTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on rich text fields.
- ObjectTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on text fields.
- ObjectTypeBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on Boolean object type fields.
- ObjectTypeComponentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on component object type fields.
- ObjectTypeCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on currency object type fields.
- ObjectTypeDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on date object type fields.
- ObjectTypeDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on DateTime object type fields.
- ObjectTypeDocumentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on document reference object type fields.
- ObjectTypeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata for the specified object type field.
- ObjectTypeFieldMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.data
-
Retrieves a List of all object types in the
ObjectTypeFieldMetadata
once a request is built for the given object and object type. - ObjectTypeFieldMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
ObjectTypeFieldMetadataCollectionRequest
. - ObjectTypeFieldMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.data
-
Holds an
ObjectTypeFieldMetadata
collection. - ObjectTypeFieldMetadataType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of the possible object type field types.
- ObjectTypeFormulaBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on Boolean formula fields.
- ObjectTypeFormulaCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on currency formula fields.
- ObjectTypeFormulaDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on date formula fields.
- ObjectTypeFormulaDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on DateTime formula fields.
- ObjectTypeFormulaFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on object type formula fields.
- ObjectTypeFormulaFieldType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible field types for an object type formula field.
- ObjectTypeFormulaFieldTypeMetadata - Interface in com.veeva.vault.sdk.api.data
-
A representation of a typed object type formula field.
- ObjectTypeFormulaIconFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on icon formula fields.
- ObjectTypeFormulaLinkFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on link formula fields.
- ObjectTypeFormulaNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on number formula fields.
- ObjectTypeFormulaTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on text formula fields.
- ObjectTypeIdFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on ID object type fields.
- ObjectTypeLongTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on long text object type fields.
- ObjectTypeLookupBooleanFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on Boolean lookup fields.
- ObjectTypeLookupComponentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on component lookup fields.
- ObjectTypeLookupCurrencyFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on currency lookup fields.
- ObjectTypeLookupDateFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on date lookup fields.
- ObjectTypeLookupDateTimeFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on DateTime lookup fields.
- ObjectTypeLookupFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on object type lookup fields.
- ObjectTypeLookupFieldType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of all possible field types for an object type lookup field.
- ObjectTypeLookupFieldTypeMetadata - Interface in com.veeva.vault.sdk.api.data
-
A representation of a typed object type lookup field.
- ObjectTypeLookupIdFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on ID lookup fields.
- ObjectTypeLookupLongTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on long text lookup fields.
- ObjectTypeLookupNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on number lookup fields.
- ObjectTypeLookupObjectReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on object lookup fields.
- ObjectTypeLookupParentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on parent object lookup fields.
- ObjectTypeLookupPicklistFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on picklist lookup fields.
- ObjectTypeLookupRichTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on rich text lookup fields.
- ObjectTypeLookupTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common object type metadata on text lookup fields.
- ObjectTypeMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata for the specified object type.
- ObjectTypeMetadataCollectionRequest - Interface in com.veeva.vault.sdk.api.data
-
Retrieves a List of all object types in the
ObjectTypeMetadata
once a request is built for the given object. - ObjectTypeMetadataCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
ObjectTypeMetadataCollectionRequest
. - ObjectTypeMetadataCollectionResponse - Interface in com.veeva.vault.sdk.api.data
-
Holds an
ObjectTypeMetadata
collection. - ObjectTypeNumberFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on number object type fields.
- ObjectTypeObjectReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on object reference object type fields.
- ObjectTypeParentReferenceFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on parent reference object type fields.
- ObjectTypePicklistFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on picklist object type fields.
- ObjectTypeRichTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on rich text object type fields.
- ObjectTypeTextFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on text object type fields.
- ObjectTypeUnboundDocumentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on unbound document object type fields.
- ObjectUnboundDocumentFieldMetadata - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve common metadata on unbound document fields.
- onError(MessageDeliveryEventHandlerContext) - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandler
-
Handles actions to take when the final Spark message delivery retry fails.
- onError(Consumer<AnnotationReadErrorResult>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadOperation
-
Sets the function called when the entire read operation fails.
- onError(Consumer<RecordMergeOperationError>) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeOperation
-
Required: A function called during execution when a record merge operation fails to start due to error(s).
- 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. - onError(Consumer<DocumentLifecycleUserActionExecutionError>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionOperation
-
Sets the function called when the user action execution encounters an error.
- onError(Consumer<UserActionExecutionOperationError>) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionOperation
-
Sets the function called when the user action execution encounters an error.
- onError(Consumer<QueryOperationError>) - Method in interface com.veeva.vault.sdk.api.query.QueryOperation
-
Sets the function called when VQL execution fails with a
QueryOperationErrorType
. - onError(Consumer<WorkflowActionError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsOperation
-
Sets the function called when adding participants to an active workflow has errors.
- onError(Consumer<WorkflowActionError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelOperation
-
Sets the function called when the workflow cancel has errors.
- onError(Consumer<WorkflowActionError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsOperation
-
Sets the function called when removing items from an active workflow has errors.
- onError(Consumer<WorkflowActionError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerOperation
-
Sets the function called when replacing the owner of an active workflow has errors.
- onError(Consumer<WorkflowActionError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateOperation
-
Sets the function called when updating the due date of an active workflow has errors.
- onError(Consumer<WorkflowStartInstanceError>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceOperation
-
Sets the function called when the workflow start has errors.
- onError(Consumer<E>) - Method in interface com.veeva.vault.sdk.api.core.VaultInformationOperation
-
Called during execution if the remote Vault information cannot be obtained.
- 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.
- onMergeComplete(RecordMergeEventCompletionContext) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeEventHandler
-
Invoked when the merge completes.
- onMergeStart(RecordMergeEventStartContext) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeEventHandler
-
Invoked when the merge starts.
- onPostExecute(PostExecutionDocumentActionUIContext) - Method in interface com.veeva.vault.sdk.api.action.DocumentAction
-
The logic to execute after the action is invoked during the post-execution phase.
- onPostExecute(PostExecutionRecordActionUIContext) - Method in interface com.veeva.vault.sdk.api.action.RecordAction
-
The logic to execute after the action is invoked, during the post-execution phase.
- onPreExecute(PreExecutionDocumentActionUIContext) - Method in interface com.veeva.vault.sdk.api.action.DocumentAction
-
The logic to execute before the action is invoked during the pre-execution phase.
- onPreExecute(PreExecutionRecordActionUIContext) - Method in interface com.veeva.vault.sdk.api.action.RecordAction
-
The logic to execute before the action is invoked, during the pre-execution phase.
- onSend(MessageDeliveryEventHandlerSendContext) - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandler
-
Executed before each outbound Spark message delivery try or retry.
- onSuccess(Consumer<AnnotationReadResponse>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadOperation
-
Sets the function called when the read operation completes successfully.
- onSuccess(Consumer<RecordMergeOperationResponse>) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeOperation
-
Optional: A function called during execution if the record merge operation successfully starts.
- 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.
- onSuccess(Consumer<DocumentLifecycleUserActionExecutionResponse>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionOperation
-
Sets the function called when the user action execution succeeds.
- onSuccess(Consumer<WorkflowActionResponse>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsOperation
-
Sets the function called when adding participants to an active workflow succeeds.
- onSuccess(Consumer<WorkflowActionResponse>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelOperation
-
Sets the function called when the workflow cancel succeeds.
- onSuccess(Consumer<WorkflowActionResponse>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerOperation
-
Sets the function called when replacing the owner of an active workflow succeeds.
- onSuccess(Consumer<WorkflowActionResponse>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateOperation
-
Sets the function called when updating the due date of an active workflow succeeds.
- onSuccess(Consumer<WorkflowRemoveItemsResponse>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsOperation
-
Sets the function called when removing items from an active workflow succeeds.
- onSuccess(Consumer<S>) - Method in interface com.veeva.vault.sdk.api.core.VaultInformationOperation
-
Called during execution if the remote VaultInformation was obtained successfully.
- onSuccess(Consumer<T>) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionOperation
-
Sets the function called when the user action execution succeeds.
- onSuccess(Consumer<T>) - Method in interface com.veeva.vault.sdk.api.query.QueryOperation
-
Sets the function called when VQL execution completes successfully.
- onSuccess(Consumer<T>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceOperation
-
Sets the function called when the workflow start succeeds.
- 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.
- OPERATION_FAILED - Enum constant in enum class com.veeva.vault.sdk.api.edl.MatchedDocumentErrorType
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordAttachmentBatchOperationErrorType
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordMergeOperationErrorType
-
Errors where the operation is not allowed due to configuration.
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Indicates the operation is not allowed due to insufficient permissions.
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
The operation is not allowed.
- OPERATION_NOT_ALLOWED - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
The query uses syntax that is not allowed in SDK.
- OR - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Logical
OR
between two boolean expressions. - order() - Element in annotation interface com.veeva.vault.sdk.api.data.RecordTriggerInfo
-
The order that a trigger shall execute relative to other triggers for the same object, Event, and eventSegment.
- order() - Element in annotation interface com.veeva.vault.sdk.api.role.RecordRoleTriggerInfo
-
The order that a trigger shall execute relative to other triggers for the same object, Event, and eventSegment.
P
- PARENT_OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a parent object reference object field.
- PARENT_OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a parent object reference object field.
- PARENT_OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type parent reference.
- PARENT_OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a parent object reference object type field.
- PARENT_OBJECT_REFERENCE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type parent reference.
- PARTICIPANT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- PARTICIPANT_GROUP - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "Workflow participant group" field type input.
- PATCH - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpMethod
- PERMISSION_DENIED - Enum constant in enum class com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
The requesting user does not have permission to execute the action.
- Picklist - Interface in com.veeva.vault.sdk.api.picklist
-
Provides information about a picklist.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a picklist object field.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a picklist object field.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type picklist.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a picklist object type field.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type picklist.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a picklist document field.
- PICKLIST - Enum constant in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
- PICKLIST_VALUES - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
- PICKLIST_VALUES - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
- PicklistRequest - Interface in com.veeva.vault.sdk.api.picklist
-
Request to retrieve a
Picklist
object. - PicklistRequest.Builder - Interface in com.veeva.vault.sdk.api.picklist
-
Creates an instance of
PicklistRequest
. - PicklistService - Interface in com.veeva.vault.sdk.api.picklist
-
Service to retrieve picklist information.
- PicklistValue - Interface in com.veeva.vault.sdk.api.picklist
-
Provides access to picklist values, allowing retrieval of labels, status, and name.
- 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.
- POST - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpMethod
- POST_CUSTOM - Enum constant in enum class com.veeva.vault.sdk.api.core.EventSegment
- PostExecutionDocumentActionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the post-execution phase for a document action in the
USER_ACTION
use case. - PostExecutionRecordActionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the post-execution phase for a record action in the
USER_ACTION
use case. - PostExecutionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the post-execution phase for a record or document action in the
USER_ACTION
use case. - PostExecutionUserActionUIBehavior - Interface in com.veeva.vault.sdk.api.action
-
Contains additional UI data to be utilized for a record or document action during the post-execution phase in the
USER_ACTION
use case. - PostExecutionUserActionUIBehavior.Builder - Interface in com.veeva.vault.sdk.api.action
-
Build a
PostExecutionUserActionUIBehavior
with UI data to be set in the action'sonPostExecute
method. - PRE_CUSTOM - Enum constant in enum class com.veeva.vault.sdk.api.core.EventSegment
- PreExecutionDocumentActionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the pre-execution phase for a document action in the
USER_ACTION
use case. - PreExecutionRecordActionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the pre-execution phase for a record action in the
USER_ACTION
use case. - PreExecutionUIContext - Interface in com.veeva.vault.sdk.api.action
-
Set UI components during the pre-execution phase for a record or document action in the
USER_ACTION
use case. - PreExecutionUserActionUIBehavior - Interface in com.veeva.vault.sdk.api.action
-
Contains additional UI data to be utilized for a record or document action during the pre-execution phase in the
USER_ACTION
use case. - PreExecutionUserActionUIBehavior.Builder - Interface in com.veeva.vault.sdk.api.action
-
Build a
PreExecutionUserActionUIBehavior
with UI data to be set in the action'sonPreExecute
method. - process(JobProcessContext) - Method in interface com.veeva.vault.sdk.api.job.Job
-
Processes the
Job
. - PUT - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpMethod
- putMessage(Message) - Method in interface com.veeva.vault.sdk.api.queue.QueueService
-
Puts a
Message
onto a queue specified byQueueService.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(QueryExecutionRequest) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Creates an operation to execute the given
queryExecutionRequest
. - query(String) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Deprecated.as of 21R3.4, replaced by
QueryService.query(QueryExecutionRequest)
- Query - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL query.
- Query.Builder - Interface in com.veeva.vault.sdk.api.query
-
Creates an instance of
Query
. - QueryCountRequest - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL count query request which can be submitted through
QueryService.count(QueryCountRequest)
. - QueryCountRequest.Builder - Interface in com.veeva.vault.sdk.api.query
-
Creates an instance of
QueryCountRequest
. - QueryCountResponse - Interface in com.veeva.vault.sdk.api.query
-
Represents the result of a count query execution.
- QueryEditableFieldResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.EDITABLE_FIELDS
. - QueryEscapeOverride - Enum Class in com.veeva.vault.sdk.api.query
-
Valid overrides for the default escape strategy in a VQL query.
- QueryExecutionRequest - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL query request which can be submitted through
QueryService.query(QueryExecutionRequest)
. - QueryExecutionRequest.Builder - Interface in com.veeva.vault.sdk.api.query
-
Creates an instance of
QueryExecutionRequest
. - QueryExecutionResponse - Interface in com.veeva.vault.sdk.api.query
-
Represents the result of a VQL query execution.
- QueryExecutionResult - Interface in com.veeva.vault.sdk.api.query
-
Represents a single row in
QueryExecutionResponse
. - QueryFacetRequest - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL facet request, which can be passed to
QueryExecutionRequest.Builder.withQueryFacetRequest(QueryFacetRequest)
orQueryCountRequest.Builder.withQueryFacetRequest(QueryFacetRequest)
. - QueryFacetRequest.Builder - Interface in com.veeva.vault.sdk.api.query
-
Creates an instance of
QueryFacetRequest
. - QueryFacetResponse - Interface in com.veeva.vault.sdk.api.query
-
Represents the facet response of a query execution.
- QueryFacetResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the result for a single field in a
QueryFacetResponse
. - QueryFacetResultType - Interface in com.veeva.vault.sdk.api.query
-
Contains type information for a
QueryFacetResult
. - QueryFacetValue<T> - Interface in com.veeva.vault.sdk.api.query
-
Represents a single value in a
QueryFacetResult
. - QueryHiddenFieldResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.HIDDEN_FIELDS
. - QueryHiddenSubqueryResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.HIDDEN_SUBQUERIES
. - QueryLogicalOperator - Enum Class in com.veeva.vault.sdk.api.query
-
Valid logical operators for VQL queries.
- QueryObjectRule - Interface in com.veeva.vault.sdk.api.integration
-
Provides methods to retrieve information related to a query object rule.
- QueryOperation<T> - Interface in com.veeva.vault.sdk.api.query
-
A sequence of instructions that can be chained together, building a query operation which can be executed with
QueryOperation.execute()
. - QueryOperationError - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL query operation error.
- QueryOperationErrorType - Enum Class in com.veeva.vault.sdk.api.query
-
Error types that may occur during
QueryOperation
execution. - QueryRecordPermissionResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.RECORD_PERMISSIONS
. - QueryRecordPropertyResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of a
QueryRecordPropertyType
. - QueryRecordPropertyType - Enum Class in com.veeva.vault.sdk.api.query
-
Valid values for types of record properties to request.
- QueryRedactedFieldResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.REDACTED_FIELDS
. - QueryResponse - Interface in com.veeva.vault.sdk.api.query
-
Deprecated.as of 21R3.4, see
QueryService.query(String)
- QueryResult - Interface in com.veeva.vault.sdk.api.query
-
Deprecated.as of 21R3.4, see
QueryService.query(String)
- QueryService - Interface in com.veeva.vault.sdk.api.query
-
Service to execute VQL queries.
- QueryTargetOption - Enum Class in com.veeva.vault.sdk.api.query
-
Valid options to modify the scope of a VQL query target.
- QueryValidationRequest - Interface in com.veeva.vault.sdk.api.query
-
Represents a VQL query request which can be validated through
QueryService.validate(QueryValidationRequest)
. - QueryValidationRequest.Builder - Interface in com.veeva.vault.sdk.api.query
-
Creates an instance of
QueryValidationRequest
. - QueryValidationResponse - Interface in com.veeva.vault.sdk.api.query
-
Represents the result of a query validation execution.
- QueryWeblink - Interface in com.veeva.vault.sdk.api.query
-
Represents attributes of a weblink, as defined in a
hyperlink
function. - QueryWeblinkFieldResult - Interface in com.veeva.vault.sdk.api.query
-
Represents the output of
QueryRecordPropertyType.WEBLINK_FIELDS
. - QueryWeblinkTarget - Enum Class in com.veeva.vault.sdk.api.query
-
Valid values for how a weblink opens in a browser tab or window.
- QueueService - Interface in com.veeva.vault.sdk.api.queue
-
Provides methods to create and put messages in a queue.
R
- RAW - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Represents a raw object, previously known as a high volume object (HVO).
- readAnnotations(AnnotationReadRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Given either a
List
of unique annotation IDs or a document version to read annotations from, returns anAnnotationReadOperation
to execute. - 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)
. - readReplies(AnnotationReplyReadRequest) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationService
-
Given the ID of a parent annotation, returns an
AnnotationReadOperation
to execute to read its replies. - readTranslations(TranslationsReadRequest) - Method in interface com.veeva.vault.sdk.api.i18n.TranslationService
-
Read the Messages in the given
Messagegroup
and language. - Record - Interface in com.veeva.vault.sdk.api.data
-
Represents a Vault object record.
- RECORD - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Maps to the
WorkflowItemRecord
item type in a workflow - RECORD_PERMISSIONS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
Edit, delete, create, and read permissions for this record for the querying user.
- 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 Interface in com.veeva.vault.sdk.api.action
-
Indicates a class is a record action.
- RecordAttachmentBatchOperation - Interface in com.veeva.vault.sdk.api.data
-
Batch Operation to create, update, or delete a batch of record attachment.
- RecordAttachmentBatchOperationError - Interface in com.veeva.vault.sdk.api.data
-
Interface for recording the errors of the batch operation for creating, updating, or deleting record attachments.
- RecordAttachmentBatchOperationErrorType - Enum Class in com.veeva.vault.sdk.api.data
-
The error type of batch operation for creating,updating, or deleting record attachments.
- RecordAttachmentFileReference - Interface in com.veeva.vault.sdk.api.data
-
Represents an attachment file from the current or another Vault which is a subclass of DocumentFileReference with additional object related information.
- RecordAttachmentFileReferenceRequest - Interface in com.veeva.vault.sdk.api.data
-
Interfaces for building all the supported file reference for creating attachments for object record.
- RecordAttachmentFileReferenceRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordAttachmentFileReferenceRequest
. - RecordAttachmentPositionResult - Interface in com.veeva.vault.sdk.api.data
-
Provides access to the attachment ID and version ID of the row-level fields for each entry in the result.
- RecordAttachmentPositionResultType - Enum Class in com.veeva.vault.sdk.api.data
-
Initiates the result of saving a record attachment.
- RecordBatchDeleteRequest - Interface in com.veeva.vault.sdk.api.data
-
A delete request designed to contain additional parameters when performing a batch record delete from
RecordService
- RecordBatchDeleteRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordBatchDeleteRequest
- RecordBatchOperation - Interface in com.veeva.vault.sdk.api.data
-
Batch Operation to perform on records.
- RecordBatchSaveRequest - Interface in com.veeva.vault.sdk.api.data
-
A save request designed to contain additional parameters when performing a batch record save from
RecordService
. - RecordBatchSaveRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordBatchSaveRequest
. - RecordChange - Interface in com.veeva.vault.sdk.api.data
-
Represents a Record that is being modified.
- RecordDisplayRequest - Interface in com.veeva.vault.sdk.api.data
-
A request designed to contain records and additional parameters for retrieving the record display values in
RecordDisplayService
. - RecordDisplayRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordDisplayRequest
. - RecordDisplayResult - Interface in com.veeva.vault.sdk.api.data
-
Holds a collection of field display values for a record.
- RecordDisplayService - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to retrieve UI display values from records.
- RecordEvent - Enum Class in com.veeva.vault.sdk.api.data
-
Contains valid Event values to specify when the trigger occurs.
- RecordMergeCompletionStatus - Enum Class in com.veeva.vault.sdk.api.data
-
Contains valid statuses for merge sets that have completed a merge.
- RecordMergeError - Interface in com.veeva.vault.sdk.api.data
-
Contains an individual error which occurred when attempting to start a record merge operation.
- RecordMergeEventCompletionContext - Interface in com.veeva.vault.sdk.api.data
- RecordMergeEventContext - Interface in com.veeva.vault.sdk.api.data
-
Input to
RecordMergeEventHandler
methods. - RecordMergeEventHandler - Interface in com.veeva.vault.sdk.api.data
-
Executes custom logic during record merges.
- RecordMergeEventHandlerInfo - Annotation Interface in com.veeva.vault.sdk.api.data
-
Indicates a class is a
RecordMergeEventHandler
. - RecordMergeEventStartContext - Interface in com.veeva.vault.sdk.api.data
- RecordMergeOperation - Interface in com.veeva.vault.sdk.api.data
-
Starts a record merge.
- RecordMergeOperationError - Interface in com.veeva.vault.sdk.api.data
-
Contains the List of errors from starting a record merge job.
- RecordMergeOperationErrorType - Enum Class in com.veeva.vault.sdk.api.data
-
Contains valid values for error types when starting a record merge.
- RecordMergeOperationResponse - Interface in com.veeva.vault.sdk.api.data
-
Response when a record merge job successfully starts.
- RecordMergeRequest - Interface in com.veeva.vault.sdk.api.data
-
Request containing data for starting a record merge.
- RecordMergeRequest.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordMergeRequest
. - RecordMergeSet - Interface in com.veeva.vault.sdk.api.data
-
Represents a merge set to be merged.
- RecordMergeSetInput - Interface in com.veeva.vault.sdk.api.data
-
Contains information about the merge set, such as which record is main and which is duplicate.
- RecordMergeSetInput.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
RecordMergeSetInput
. - RecordMergeSetResult - Interface in com.veeva.vault.sdk.api.data
-
Represents the result of attempting to merge a merge set.
- 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 Class in com.veeva.vault.sdk.api.role
-
Contains valid Event values to specify when the trigger occurs.
- RecordRoleService - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to retrieve and update
RecordRole
s. - RecordRoleTrigger - Interface in com.veeva.vault.sdk.api.role
-
Invoked to start a trigger; takes
RecordRoleTriggerContext
as input. - RecordRoleTriggerContext - Interface in com.veeva.vault.sdk.api.role
-
Input to a
RecordRoleTrigger
. - RecordRoleTriggerInfo - Annotation Interface 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
. - RECORDS - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationValueType
- RecordService - Interface in com.veeva.vault.sdk.api.data
-
Provides methods to create, read, update, and delete object 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 Interface in com.veeva.vault.sdk.api.data
-
Indicates a class is a
RecordTrigger
. - RecordWorkflowAction - Interface in com.veeva.vault.sdk.api.workflow
-
Executes custom logic on a record during workflow events; takes a
RecordWorkflowActionContext
as input. - RecordWorkflowActionContext - Interface in com.veeva.vault.sdk.api.workflow
-
Contains contextual information about an active workflow during execution.
- RecordWorkflowActionInfo - Annotation Interface in com.veeva.vault.sdk.api.workflow
-
Indicates a class is a
RecordWorkflowAction
that can be executed against a workflow for an object record. - RecordWorkflowActionTaskContext - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to update and retrieve information for tasks of an active workflow.
- REDACTED_FIELDS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
List of selected fields redacted from this result row for the querying user.
- REFERENCE_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Indicates the query item has a missing reference lookup.
- ReferenceLookupType - Enum Class in com.veeva.vault.sdk.api.integration
-
Valid reference look up types for
Fieldrule
subcomponent underIntegrationrule
. - REFERENCES - Static variable in interface com.veeva.vault.sdk.api.core.ValueType
- REMOVE_ITEMS - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Removes items in an active workflow.
- 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.
- removeItems(WorkflowRemoveItemsRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowRemoveItemsOperation
, which can be used to remove items in an active workflow based on the providedWorkflowRemoveItemsRequest
. - RemoveMatchedDocument - Interface in com.veeva.vault.sdk.api.edl
-
Represents a manually matched document to remove from an EDL Item.
- RemoveMatchedDocument.Builder - Interface in com.veeva.vault.sdk.api.edl
-
Creates an instance of
RemoveMatchedDocument
. - 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 givenname
from the request context. - RENDITION_NOT_FOUND - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error that occurred because the specified document version lacks a rendition that accepts annotations.
- REPLACE_WORKFLOW_OWNER - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Replaces the workflow owner of an active workflow.
- 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.
- replaceWorkflowOwner(WorkflowReplaceOwnerRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowReplaceOwnerOperation
, which can be used to replace the owner of an active workflow based on the providedWorkflowReplaceOwnerRequest
. - REQUEST_OWNER - Enum constant in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Indicates the owner of the sdk request.
- REQUEST_OWNER - Enum constant in enum class com.veeva.vault.sdk.api.core.RequestContextUserType
-
Indicates the owner of the sdk request.
- RequestContext - Interface in com.veeva.vault.sdk.api.core
-
Provides access to the context in which the current request is made.
- RequestContextUserType - Enum Class in com.veeva.vault.sdk.api.core
-
Types of users available in a SDK request.
- 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.
- RequestExecutionContext - Interface in com.veeva.vault.sdk.api.core
-
Base interface for request execution context.
- RESPONSE_BODY_CONVERSION_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Indicates an error during conversion of the response body: to
valueType
whenHttpService.send(HttpRequest, HttpResponseBodyValueType)
is used or toCsvData
whenHttpService.send(HttpRequest, CsvReadParameters)
is used - RICHTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a rich text object field.
- RICHTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a rich text object field.
- RICHTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type rich text.
- RICHTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a rich text object type field.
- RICHTEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type rich text.
- 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
Row
s. - run(JobParameters) - Method in interface com.veeva.vault.sdk.api.job.JobService
-
Runs a job as specified in a
JobParameters
object. - runJob(JobParameters) - Method in interface com.veeva.vault.sdk.api.job.JobService
-
Runs a job as specified in a
JobParameters
object, and also returns aJobRunResult
object. - RuntimeService - Interface in com.veeva.vault.sdk.api.core
-
Provides methods for handling the Java SDK runtime.
S
- SAME_WINDOW - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryWeblinkTarget
-
Link opens in the current tab.
- saveDocumentVersions(List<DocumentVersion>) - Method in interface com.veeva.vault.sdk.api.document.DocumentService
-
Save the specified
DocumentVersion
s. - SaveDocumentVersionsResponse - Interface in com.veeva.vault.sdk.api.document
-
Response from a call to
DocumentService.saveDocumentVersions(List)
. - SaveMatchedDocument - Interface in com.veeva.vault.sdk.api.edl
-
Represents a matched document to save to an EDL Item.
- SaveMatchedDocument.Builder - Interface in com.veeva.vault.sdk.api.edl
-
Creates an instance of
SaveMatchedDocument
. - SaveRecordAttachment - Interface in com.veeva.vault.sdk.api.data
-
Interface for creating/updating record attachment in the batch operation.
- SaveRecordAttachment.Builder - Interface in com.veeva.vault.sdk.api.data
-
Creates an instance of
SaveRecordAttachment
. - SaveRecordAttachmentsResponse - Interface in com.veeva.vault.sdk.api.data
-
Interface for returning the response of executing the batch CUD operations for object record attachments.
- saveRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordService
-
Deprecated.as of 17R2.2, replaced by
RecordService.batchSaveRecords(RecordBatchSaveRequest)
- SaveRecordsResponse - Interface in com.veeva.vault.sdk.api.data
-
Deprecated.as of 17R2.2, see
RecordService.saveRecords(List)
- SDK_CURRENT_USER - Enum constant in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Deprecated.as of 22R3.4, replaced by
ConnectionUser.REQUEST_OWNER
andConnectionUser.INITIATING_USER
. - send(HttpRequest, CsvReadParameters) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 24R1.1, replaced by
HttpService.sendRequest(HttpWebRequest, CsvReadParameters)
- send(HttpRequest, HttpResponseBodyValueType<T>) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 24R1.1, replaced by
HttpService.sendRequest(HttpWebRequest, HttpResponseBodyValueType)
- send(HttpRequest, Class<U>) - Method in interface com.veeva.vault.sdk.api.http.HttpService
-
Deprecated.as of 24R1.1, replaced by
HttpService.sendRequest(HttpWebRequest, Class)
- 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.
- sendRequest(HttpWebRequest, 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 customcsvReadParameters
. - sendRequest(HttpWebRequest, 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
. - sendRequest(HttpWebRequest, 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. - 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
- SESSION_ID - Static variable in interface com.veeva.vault.sdk.api.http.HttpTokens
-
Resolves a valid Vault session token for the currently authenticated user.
- SET_NULL - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Represents the set null delete type.
- setAttachmentVersion(int) - Method in interface com.veeva.vault.sdk.api.document.DocumentAttachmentFileReference
-
Sets the version of a
DocumentAttachment
. - 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 an attribute with the name and value of a valid message token.
- setBody(CsvData) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as CSV as returned by
CsvData.asString()
. - setBody(JsonArray) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as JSON as returned by
JsonArray.asString()
. - setBody(JsonObject) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as JSON as returned by
JsonObject.asString()
. - setBody(String) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as a string.
- 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. - setBody(U) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies request body as the serialized form of the provided
UserDefinedModel
. - 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. - setContentType(HttpRequestContentEnumType) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies the
Content-Type
header for this HTTP request. - 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.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.
- 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.
- setJobOwner(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Sets the job owner.
- setJobRunTime(ZonedDateTime) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Sets the job start time.
- setJobTitle(String) - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
Sets the job title.
- 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.
- setNotificationMode(NotificationMode...) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Choose where the user will receive this notification.
- setNotificationText(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationMessage
-
Sets the text of the in-app notification displayed in the Vault UI.
- setNotifyByEmailOnly(boolean) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Deprecated.as of 22R3.4, replaced by
NotificationParameters.setNotificationMode(com.veeva.vault.sdk.api.notification.NotificationMode...)
- 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 User (
user__sys
) record ids who will receive the notification. - setReplyToByPersonId(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the Person (
person__sys
) record ID who will receive notification responses. - setReplyToByUserId(String) - Method in interface com.veeva.vault.sdk.api.notification.NotificationParameters
-
Sets the User (
user__sys
) record id who will receive notification responses. - setResolveTokens(boolean) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies whether to resolve tokens used in headers, body parameters, and body.
- setRetry() - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Flags this task for retry.
- 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.
- setTokenRequest(TokenRequest) - Method in interface com.veeva.vault.sdk.api.http.HttpRequest
-
Specifies the custom tokens that should be resolved in headers, body parameters, and body.
- setTokenRequest(TokenRequest) - Method in interface com.veeva.vault.sdk.api.queue.MessageDeliveryEventHandlerSendContext
-
Sets a
TokenRequest
for the queue message. - 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(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.core.RequestContext
-
Adds the given
value
identified by the givenname
to the request context. - 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 a property 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 document parent of the attachment.
- SharedAttachment - Interface in com.veeva.vault.sdk.api.core
-
Interface to share between Document Attachment and Record Attachment when creating a new attachment on either a document or an object record.
- SIMPLE - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataJoinType
-
Represents the simple join type.
- 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.
- SourceType - Enum Class in com.veeva.vault.sdk.api.data
-
A list of the possible field source types.
- SPECIFIC_VERSION - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
This is a representation of a specific document version field.
- 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. - STANDARD - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Represents a standard volume object (SVO).
- STANDARD - Enum constant in enum class com.veeva.vault.sdk.api.data.SourceType
-
This is a representation of a standard source type.
- START - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Start step.
- startWorkflow(WorkflowStartInstanceRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Starts the workflow with the workflow name, list of document IDs or record IDs, and input parameters.
- stepTypes() - Element in annotation interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionInfo
-
Indicates the workflow step types this action supports.
- streamFields() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.
- streamFields() - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionResponse
-
Streams the document fields in the native format,
DocumentField
. - streamResults() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadResponse
-
Returns a
Stream
of the requestedAnnotation
s. - streamResults() - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionResponse
-
Streams the query results in the native query format,
QueryExecutionResult
. - streamResults() - Method in interface com.veeva.vault.sdk.api.query.QueryResponse
-
Deprecated.Streams the query results in the native query format,
QueryResult
. - streamRows() - Method in interface com.veeva.vault.sdk.api.csv.CsvData
- streamSavedAnnotations() - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveSuccess
-
Retrieves a
Stream
of the IDs of the newly created annotations resulting from the associated input annotation. - STRING - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
This is a representation of a text object field.
- STRING - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a text document field.
- STRING - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueType
-
Used by fields with text values.
- STRING - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceValueType
-
Used by fields with text values.
- STRING - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationValueType
-
Used by fields with text values.
- 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.
- STRING - Static variable in interface com.veeva.vault.sdk.api.workflow.WorkflowInputValueType
-
Maps to the "Text" field type input.
- STRING_LIST - Static variable in interface com.veeva.vault.sdk.api.annotation.AnnotationValueType
-
Represents a list of text values.
- 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
- SUBTYPE - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
The subtype level.
- SUCCESS - Enum constant in enum class com.veeva.vault.sdk.api.data.RecordMergeCompletionStatus
-
Indicates a successful record merge.
- SUCCESS - Enum constant in enum class com.veeva.vault.sdk.api.job.TaskState
- suppressBanner() - Method in interface com.veeva.vault.sdk.api.action.PostExecutionUserActionUIBehavior.Builder
-
Suppresses the default success banner notification.
- 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.
- SYSTEM - Enum constant in enum class com.veeva.vault.sdk.api.data.SourceType
-
This is a representation of a system source type.
- SYSTEM_PROVIDED_GROUP - Enum constant in enum class com.veeva.vault.sdk.api.group.GroupType
-
Groups provided by Vault, for example, "All Internal Users."
T
- TASK - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Workflow task step.
- TASK_AFTER_ASSIGN - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately after acceptance or reassignment of a task instance.
- TASK_AFTER_CANCEL - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately after cancellation of a task instance.
- TASK_AFTER_COMPLETE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately after completion of a task instance.
- TASK_AFTER_CREATE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately after task creation.
- TASK_BEFORE_COMPLETE_DIALOG - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Occurs immediately before displaying the completion dialog of a task instance.
- TaskOutput - Interface in com.veeva.vault.sdk.api.job
-
Methods to get and set output parameters for a job task.
- TaskState - Enum Class in com.veeva.vault.sdk.api.job
-
Contains valid values to define the state of a task.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
This is a representation of a text object field.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Represents a formula field with text return type.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Represents a source field with type text.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
This is a representation of a text object type field.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Represents a formula field with type text.
- TEXT - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Represents a source field with type text.
- TEXT_CSV - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
CSV content type (text/csv).
- TEXT_HTML - Enum constant in enum class com.veeva.vault.sdk.api.email.EmailBodyType
-
Indicates this email body content type is text/html.
- TEXT_HTML - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
HTML content type (text/html).
- TEXT_PLAIN - Enum constant in enum class com.veeva.vault.sdk.api.email.EmailBodyType
-
Indicates this email body content type is text/plain.
- TEXT_PLAIN - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Plain text content type (text/plain).
- TEXT_XML - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Text XML content type (text/xml).
- TIMEOUT - Enum constant in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Indicates that HTTP request execution failed to complete within the time specified by
HttpRequest.setTimeout(int)
. - TIMEOUT - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
The query request failed to complete in the time allowed by VQL.
- TokenRequest - Interface in com.veeva.vault.sdk.api.token
-
A request that contains mappings between custom token names and the values that will be resolved if those tokens are encountered during token resolution in supported operations.
- TokenRequest.Builder - Interface in com.veeva.vault.sdk.api.token
-
Builds a
TokenRequest
. - TokenResolverInput - Interface in com.veeva.vault.sdk.api.notification
-
Provides input for resolving token values.
- TokenResolverOutput - Interface in com.veeva.vault.sdk.api.notification
-
Collects resolved values for tokens specified in
TokenResolverInput
. - TokenService - Interface in com.veeva.vault.sdk.api.token
-
Service to support custom token resolution for supported operations.
- toList() - Static method in class com.veeva.vault.sdk.api.core.VaultCollectors
-
Returns a
Collector
that accumulates the input elements into a newList
. - 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 aMap
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 aMap
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 newSet
. - TranslationService - Interface in com.veeva.vault.sdk.api.i18n
-
Provides methods to retrieve translated Messages in a
Messagegroup
and to replace Message tokens with values. - TranslationsReadRequest - Interface in com.veeva.vault.sdk.api.i18n
-
Provides methods to retrieve information about what Messages to read.
- TranslationsReadRequestBuilder - Interface in com.veeva.vault.sdk.api.i18n
-
Provides methods to build
TranslationsReadRequest
objects. - TranslationsReadResponse - Interface in com.veeva.vault.sdk.api.i18n
-
Provides methods to retrieve translated Messages.
- TriggerOrder - Enum Class in com.veeva.vault.sdk.api.core
-
Contains valid values for specifying trigger execution order.
- TYPE - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
The document type level.
U
- UNDEFINED - Enum constant in enum class com.veeva.vault.sdk.api.data.ObjectMetadataJoinType
-
Represents the undefined join type.
- UNEXPECTED_ERROR - Enum constant in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
The cancellation failed due to an unexpected error.
- UNSPECIFIED - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action is available everywhere actions are supported with the exception of bulk actions.
- UNSPECIFIED - Enum constant in enum class com.veeva.vault.sdk.api.core.EventSegment
- UNSPECIFIED - Enum constant in enum class com.veeva.vault.sdk.api.core.TriggerOrder
- UNSPECIFIED - Enum constant in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Specifies this field should use the serialization behavior of the user-defined model that it belongs to.
- UPDATE_WORKFLOW_DUE_DATE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Updates the due date of an active workflow.
- updateParticipantGroup(WorkflowParticipantGroupUpdate) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Updates a specific participant group for a workflow instance.
- updateWorkflowDueDate(WorkflowUpdateDueDateRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
Creates a
WorkflowUpdateDueDateOperation
, which can be used to update the due date of an active workflow based on the providedWorkflowUpdateDueDateRequest
. - URL - Enum constant in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
This is a representation of a URL Document Field.
- Usage - Enum Class in com.veeva.vault.sdk.api.action
-
Where in Vault the action is available for configuration and execution.
- usages() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
Defines where in Vault the action is available for configuration.
- usages() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Defines where in Vault the action is available for configuration.
- USER - Enum constant in enum class com.veeva.vault.sdk.api.job.JobOwnerType
-
The job owner is a single user.
- USER_ACTION - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action supports use as a user action.
- USER_BULK_ACTION - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action supports use as a bulk action.
- user_input_object() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
Name identifying object describing user inputs to be collected immediately prior to action execution.
- user_input_object() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Name identifying object describing user inputs to be collected immediately prior to action execution.
- user_input_object_type() - Element in annotation interface com.veeva.vault.sdk.api.action.DocumentActionInfo
-
Name identifying object type describing user inputs to be collected immediately prior to action execution.
- user_input_object_type() - Element in annotation interface com.veeva.vault.sdk.api.action.RecordActionInfo
-
Name identifying object type describing user inputs to be collected immediately prior to action execution.
- USER_MANAGED_GROUP - Enum constant in enum class com.veeva.vault.sdk.api.group.GroupType
-
Groups managed by users.
- USER_PERMISSION - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorType
-
Represents an error due to an issue with the user performing the action.
- USER_PERMISSION - Enum constant in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Represents an error due to an issue with the permissions granted to the user performing the action.
- UserActionExecutionBanner - Interface in com.veeva.vault.sdk.api.action
-
Represents a post-execution banner for a record or document action in the
USER_ACTION
use case. - UserActionExecutionBanner.Builder - Interface in com.veeva.vault.sdk.api.action
-
Build a
UserActionExecutionBanner
to be set on aPostExecutionUserActionUIBehavior
during the action'sonPostExecute
method. - UserActionExecutionDialog - Interface in com.veeva.vault.sdk.api.action
-
Represents a pre-execution dialog for a record or document action in the
USER_ACTION
use case. - UserActionExecutionDialog.Builder - Interface in com.veeva.vault.sdk.api.action
-
Build a
UserActionExecutionDialog
to be set on aPreExecutionUserActionUIBehavior
during the action'sonPreExecute
method. - UserActionExecutionOperation<T> - Interface in com.veeva.vault.sdk.api.lifecycle
-
A sequence of instructions that can be chained together, building a user action execution operation that can be executed with
UserActionExecutionOperation.execute()
. - UserActionExecutionOperationError - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents an error encountered during a
UserActionExecutionOperation
. - UserActionExecutionRequest - Interface in com.veeva.vault.sdk.api.lifecycle
-
Provides methods to set the parameters necessary to execute a User Action.
- UserActionExecutionRequest.Builder - Interface in com.veeva.vault.sdk.api.lifecycle
- UserActionExecutionResponse - Interface in com.veeva.vault.sdk.api.lifecycle
-
Represents the result of the execution of a user action.
- UserActionUIService - Interface in com.veeva.vault.sdk.api.action
-
Provides builders for working pre- and post-execution UI behavior actions in the
USER_ACTION
use case. - UserDefinedClassInfo - Annotation Interface in com.veeva.vault.sdk.api.core
-
Indicates a class is a user-defined class (UDC).
- UserDefinedModel - Interface in com.veeva.vault.sdk.api.core
-
Common interface for all UserDefinedModel objects.
- UserDefinedModelInfo - Annotation Interface in com.veeva.vault.sdk.api.core
-
Indicates an interface is a user-defined model (UDM).
- UserDefinedModelService - Interface in com.veeva.vault.sdk.api.core
-
Service for handling UserDefinedModel instances.
- UserDefinedProperty - Annotation Interface in com.veeva.vault.sdk.api.core
-
This annotation is to be used on a getter/setter method of an interface that has been annotated with
UserDefinedModelInfo
and indicates that the field in its getter/setter is to be serialized/deserialized usingJsonService
. - UserDefinedPropertyInclude - Enum Class in com.veeva.vault.sdk.api.core
-
The Include enum specifies the serialization behavior of a user-defined model.
- UserDefinedService - Interface in com.veeva.vault.sdk.api.core
-
Marker interface for Vault Java SDK user-defined services.
- UserDefinedServiceInfo - Annotation Interface in com.veeva.vault.sdk.api.core
-
Indicates an interface is a user-defined service (UDS).
V
- validate(QueryValidationRequest) - Method in interface com.veeva.vault.sdk.api.query.QueryService
-
Creates an operation to validate the given
queryValidationRequest
. - valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.action.Usage
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationReadErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.EventPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.EventSegment
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.RequestContextUserType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldMissingValueBehaviorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectMetadataJoinType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.RecordAttachmentBatchOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.RecordAttachmentPositionResultType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.RecordEvent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.RecordMergeCompletionStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.RecordMergeOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.data.SourceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.edl.MatchedDocumentErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.email.EmailBodyType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.email.EmailSenderType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.group.GroupType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.http.HttpMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.job.JobOwnerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.job.TaskState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.notification.NotificationMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryTargetOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.query.QueryWeblinkTarget
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.veeva.vault.sdk.api.action.Usage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.annotation.AnnotationReadErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.connection.ConnectionUser
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.EventPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.EventSegment
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.RequestContextUserType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.csv.LineEnding
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldMissingValueBehaviorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectMetadataJoinType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeFormulaFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.ObjectTypeLookupFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.RecordAttachmentBatchOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.RecordAttachmentPositionResultType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.RecordEvent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.RecordMergeCompletionStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.RecordMergeOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.data.SourceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.document.DocumentFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.edl.MatchedDocumentErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.email.EmailBodyType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.email.EmailSenderType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.group.GroupType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.http.HttpMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.integration.ItemErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.job.JobCancelOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.job.JobOwnerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.job.TaskState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.notification.NotificationMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryTargetOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.query.QueryWeblinkTarget
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.veeva.vault.sdk.api.workflow.WorkflowType
-
Returns an array containing the constants of this enum class, 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.
- VARIABLE - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
- VAULT_GROUPS - Enum constant in enum class com.veeva.vault.sdk.api.email.EmailSenderType
-
Specific groups defined in Inbound Email Address configuration.
- VAULT_USERS - Enum constant in enum class com.veeva.vault.sdk.api.email.EmailSenderType
-
All Vault Users
- VAULT_USERS_AND_PERSONS - Enum constant in enum class com.veeva.vault.sdk.api.email.EmailSenderType
-
All Vault Users and Persons
- 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
- VaultInformation - Interface in com.veeva.vault.sdk.api.core
-
Provides access to basic configuration information about the local Vault.
- VaultInformationOperation<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
VaultInformationOperation.execute()
. - VaultInformationOperationError - Interface in com.veeva.vault.sdk.api.core
-
Provides access to
VaultInformationOperation
error type and message. - VaultInformationOperationError.VaultInformationOperationErrorType - Enum Class in com.veeva.vault.sdk.api.core
- VaultInformationService - Interface in com.veeva.vault.sdk.api.core
-
Provides methods to retrieve
VaultInformation
. - VaultRuntimeException - Exception in com.veeva.vault.sdk.api.core
-
Deprecated.as of 20R3.4
- 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 ofcause
. - VERDICT - Enum constant in enum class com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
W
- warn(String) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs an WARN type message to the Debug Log and Runtime Log.
- warn(String, Object...) - Method in interface com.veeva.vault.sdk.api.core.LogService
-
Outputs the templated WARN type message to the Debug Log and Runtime Log.
- warn(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 and Runtime Log.
- WARNING - Enum constant in enum class com.veeva.vault.sdk.api.integration.MessageErrorType
-
Indicates a warning.
- WEBLINK_FIELDS - Enum constant in enum class com.veeva.vault.sdk.api.query.QueryRecordPropertyType
-
Attributes of a web link, as defined in a
hyperlink
function. - withActionType(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadataRequest.Builder
-
Optional: sets the name of the action type associated with the requested object lifecycle user action.
- withActionType(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionMetadataRequest.Builder
-
Optional: sets the name of the action type associated with the requested object lifecycle user action.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldFilter.Builder
-
Optional: Sets a filter to retrieve active field attributes only.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionRequest.Builder
-
Optional: sets the status value for the requested object lifecycles.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionRequest.Builder
-
Optional: sets the status value for the object lifecycle stage groups requested.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Optional: sets the status value for the object lifecycle stages requested.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionRequest.Builder
-
Optional: sets the status value for the object lifecycle states requested.
- withActive(boolean) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionRequest.Builder
-
Optional: sets the status value for the object lifecycle state types requested.
- withActiveOnly() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve active object types only.
- withActiveOnly() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataRequest.Builder
-
Optional: Sets a filter to only retrieve active document lifecycles.
- withActiveOnly() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataRequest.Builder
-
Optional: Sets a filter to only retrieve active document lifecycle stage groups.
- withActiveOnly() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataRequest.Builder
-
Optional: Sets a filter only retrieve active document lifecycle stages.
- withActiveOnly() - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataRequest.Builder
-
Optional: Sets a filter to only retrieve active document lifecycle states.
- withAllowObjectTypeChange() - Method in interface com.veeva.vault.sdk.api.data.RecordBatchSaveRequest.Builder
-
Optional: Allows the SDK user to change the object type of records in the batch.
- withAllQueryObjectRules(boolean) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
Sets all available
QueryObjectRule
s for the integration rule query. - withAnnotationIds(List<String>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchDeleteRequest.Builder
-
Specifies the IDs of the annotations to be deleted.
- withAnnotationIds(List<String>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadRequest.Builder
-
Conditional: The annotation IDs of the annotations to read.
- withAnnotations(List<Annotation>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationBatchSaveRequest.Builder
-
Specifies the
Annotation
s to be created or updated. - withAnnotationTypes(Set<String>) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadRequest.Builder
-
Optional: Specifies the annotation types to limit the read operation to by name.
- withAttachmentExternalId(String) - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
The external ID of the attachment.
- withAttachmentExternalId(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The external ID of the attachment.
- withAttachmentId(String) - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
The ID of the attachment record.
- withAttachmentId(String) - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
Set the ID of the attachment for the request and return the Builder itself.
- withAttachmentId(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The ID of the attachment record.
- withAttachmentName(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The Name of the attachment.
- withAttachmentVersionId(String) - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
The version of the attachment, e.g., "1", "2" and so on.
- withAttachmentVersionId(String) - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
The version of the attachment, for example, "1", "2", and so on.
- withAttachmentVersionId(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The version of the attachment, for example, "1", "2", and so on.
- withBanner(UserActionExecutionBanner) - Method in interface com.veeva.vault.sdk.api.action.PostExecutionUserActionUIBehavior.Builder
-
Displays an in-progress banner notification with a custom message when a workflow action (in the
USER_ACTION
use case) kicks off a job. - withBody(CsvData) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as CSV as returned by
CsvData.asString()
. - withBody(JsonArray) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as JSON as returned by
JsonArray.asString()
. - withBody(JsonObject) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as JSON as returned by
JsonObject.asString()
. - withBody(String) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as a string.
- withBody(Collection<U>) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as the serialized form of the provided
UserDefinedModel
s. - withBody(U) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies request body as the serialized form of the provided
UserDefinedModel
. - withBodyParam(String, String) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies a body param.
- withClassification(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document classification name.
- withComment(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelRequest.Builder
-
Sets the cancellation comment.
- withConnectionContext(ConnectionContext) - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
Set the connectionContext for the request and return the Builder itself
- withConnectionId(String) - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequestBuilder
-
Required: Sets the connection ID.
- withConnectionName(String) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specify a
connectionName
(local, Vault to Vault, or external connection). - withContentType(HttpRequestContentType) - Method in interface com.veeva.vault.sdk.api.http.FormHttpRequest.Builder
-
Specifies the
Content-Type
header for this HTTP request. - withDescription(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The description of the attachment.
- withDialog(UserActionExecutionDialog) - Method in interface com.veeva.vault.sdk.api.action.PreExecutionUserActionUIBehavior.Builder
-
Display an execution confirmation dialog at runtime.
- withDisplayFormat() - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayRequest.Builder
-
Required: Sets a flag to retrieve display values of fields with display format attribute.
- withDocumentId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Optional: Sets the document ID value of the document to execute the action on.
- withDocumentId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataRequest.Builder
-
Optional: Sets the document ID of the document associated with the requested document lifecycle user actions.
- withDocumentIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsRequest.Builder
-
Optional: sets the list of document IDs to remove from the active workflow.
- withDocuments(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionRequest.Builder
-
Optional: sets the list of documents to search for any available workflows.
- withDocuments(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionRequest.Builder
-
Optional: sets the list of documents against which workflows are being executed.
- withDocuments(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceRequest.Builder
-
Optional: sets the list of documents to search for the specified workflow.
- withDocuments(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataRequest.Builder
-
Optional: sets the list of documents to search for the specified workflow.
- withDocumentType(DocumentType) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionRequest.Builder
-
Required: Sets the
DocumentType
. - withDocumentTypeDetailId(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document type detail record id.
- withDocumentVersionId(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReadRequest.Builder
-
Conditional: The document version ID to request annotations from.
- withDocumentVersionId(String) - Method in interface com.veeva.vault.sdk.api.edl.RemoveMatchedDocument.Builder
-
Required: Sets the document version ID of the matched document to remove.
- withDocumentVersionId(String) - Method in interface com.veeva.vault.sdk.api.edl.SaveMatchedDocument.Builder
-
Required: Sets the document version ID of the matched document to save.
- withDocumentVersionId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Optional: Sets the document version ID value of the specific document version to execute the action on.
- withDocumentVersionId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentVersionLifecycleUserActionMetadataRequest.Builder
-
Optional: Sets the document version ID of the specific document version associated with the requested document lifecycle user actions.
- withDueDate(ZonedDateTime) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateRequest.Builder
-
Required: sets the new due date.
- withDuplicateRecordId(String) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSetInput.Builder
-
Required: Record ID of the duplicate record in a merge set.
- withEditable(boolean) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldFilter.Builder
-
Optional: sets a filter to only retrieve fields which the current user has permission to edit.
- withEdlItemId(String) - Method in interface com.veeva.vault.sdk.api.edl.RemoveMatchedDocument.Builder
-
Required: Sets the ID of the EDL Item record from which to remove a manually matched document.
- withEdlItemId(String) - Method in interface com.veeva.vault.sdk.api.edl.SaveMatchedDocument.Builder
-
Required: Sets the ID of the EDL Item record to which to save a matched document.
- withErrorHandler(Consumer<JobCancelOperationError>) - Method in interface com.veeva.vault.sdk.api.job.JobCancelOperation
-
Required: Sets a callback for handling failed job cancellation requests.
- withFacetFields(List<String>) - Method in interface com.veeva.vault.sdk.api.query.QueryFacetRequest.Builder
-
Required: Sets the facet fields, replacing any existing fields.
- withField(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueSetRequest.Builder
-
Required: Sets the name of the annotation placemark field to retrieve the value set for.
- withField(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceValueSetRequest.Builder
-
Required: Sets the name of the annotation reference field to retrieve the value set for.
- withField(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationValueSetRequest.Builder
-
Required: Sets the name of the annotation field to retrieve the value set for.
- withFieldFilter(ObjectFieldFilter) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionRequest.Builder
-
Deprecated.Optional: Sets the filter to be applied for
ObjectField
bulk retrieval. - withFieldFilter(DocumentFieldFilter) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionRequest.Builder
-
Optional: Sets the filter to apply for
DocumentField
bulk retrieval. - withFieldName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldRequest.Builder
-
Deprecated.Required: Sets the field name.
- withFieldName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependencyRequest.Builder
-
Required: Sets the field name.
- withFieldNames(List<String>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve field metadata with the specified names.
- withFieldNames(List<String>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve object type fields with the specified names.
- withFieldNames(List<String>) - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayRequest.Builder
-
Optional: Sets a filter to retrieve display values of fields with the specified names.
- withFieldNames(Set<String>) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionRequest.Builder
-
Optional: Sets the field names.
- withFileReference(FileReference) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The file reference of the attachment.
- withFind(String) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
FIND
clause, replacing any previously set value. - withFrom(String, QueryTargetOption...) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the query target which appears in the
FROM
clause. - withGroupIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupInputParameter.Builder
-
Optional: sets the group IDs to add to a participant group.
- withGroupIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantInputParameter.Builder
-
Optional: sets a list of group IDs for this participant input.
- withHeader(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies an HTTP request header.
- withId(String) - Method in interface com.veeva.vault.sdk.api.job.JobCancelRequest.Builder
-
Required: Sets the ID of the job instance to cancel.
- withInputParameters(String, Object) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceRequest.Builder
-
Optional: sets the input parameter key and value to start for the specified workflow.
- withInputParameters(List<WorkflowParticipantGroupInputParameter>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsRequest.Builder
-
Required: sets the workflow participant group input parameters.
- withIntegrationPointAPIName(String) - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequestBuilder
-
Optional: Sets the integration point API Name.
- withIntegrationRule(IntegrationRule) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Required: Sets the integration rule.
- withIntegrationRule(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
Sets the
IntegrationRule
, by name, for the integration rule query. - withLanguage(String) - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequestBuilder
-
Specifies the Vault-supported language code.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataRequest.Builder
-
Required: Sets the lifecycle name for the requested document lifecycle roles.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataRequest.Builder
-
Required: Sets the lifecycle name for the requested document lifecycle states.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataRequest.Builder
-
Required: Sets the lifecycle name of the document lifecycle associated with the requested document lifecycle user action.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadataRequest.Builder
-
Required: Sets the lifecycle name associated with the user action of the requested document lifecycle user action user input.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataRequest.Builder
-
Optional: sets the object lifecycle name.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionRequest.Builder
-
Required: sets the lifecycle name for the requested object lifecycle roles.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataRequest.Builder
-
Required: sets the object lifecycle name.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionRequest.Builder
-
Required: sets the name of the object lifecycle associated with the object lifecycle stage groups to retrieve metadata of.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Optional: sets the name of the object lifecycle associated with the object lifecycle stages to retrieve metadata of.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionRequest.Builder
-
Required: sets the lifecycle name for the requested object lifecycle states.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataRequest.Builder
-
Required: sets the lifecycle name for the requested object lifecycle state.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionRequest.Builder
-
Required: sets the lifecycle name for the requested object lifecycle state types.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataRequest.Builder
-
Required: sets the lifecycle name for the requested object lifecycle state type.
- withLifecycleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadataRequest.Builder
-
Required: sets the lifecycle name of the record associated with the requested object lifecycle user action.
- withLifecycleNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleMetadataRequest.Builder
-
Optional: Sets the document lifecycle names to retrieve metadata of.
- withLifecycleState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionMetadataRequest.Builder
-
Required: sets the lifecycle state of the record associated with the requested object lifecycle user action.
- withLifecycleState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionMetadataRequest.Builder
-
Optional: sets the lifecycle state of the record associated with the requested object lifecycle user action.
- withLocalConnection(RequestContextUserType) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specify a
RequestContextUserType
to represent a local connection to the current vault as the provided user type. - withLocalizedLabels() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve localized labels and localized plural labels in the current user's language.
- withMainRecordId(String) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeSetInput.Builder
-
Required: Record ID of the main record in a merge set.
- withMatchedDocuments(List<RemoveMatchedDocument>) - Method in interface com.veeva.vault.sdk.api.edl.BatchRemoveMatchedDocumentsRequest.Builder
-
Specifies the List of manually matched documents to remove.
- withMatchedDocuments(List<SaveMatchedDocument>) - Method in interface com.veeva.vault.sdk.api.edl.BatchSaveMatchedDocumentsRequest.Builder
-
Specifies the List of matched documents to save to an EDL Item.
- withMaxRows(long) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
MAXROWS
clause, replacing any previously set value. - withMessage(String) - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionBanner.Builder
-
Required: Set the message in this banner.
- withMessage(String) - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionDialog.Builder
-
Required: Set the message in this dialog.
- withMessageGroup(String) - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequestBuilder
-
Specifies the name of a
Messagegroup
. - withMessages(List<String>) - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequestBuilder
-
Specifies a collection of Message names.
- withMethod(HttpMethod) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies the HTTP method of the request.
- withMigrationMode() - Method in interface com.veeva.vault.sdk.api.data.RecordBatchSaveRequest.Builder
-
Optional: Sets Migration Mode to true.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationFieldRequest.Builder
-
Required: Sets the name of the field.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkFieldRequest.Builder
-
Required: Sets the name of the placemark field.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkTypeRequest.Builder
-
Required: Sets the name of the placemark type.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceFieldRequest.Builder
-
Required: Sets the name of the reference field.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceTypeRequest.Builder
-
Required: Sets the name of the reference type.
- withName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationTypeRequest.Builder
-
Required: Sets the name of the annotation type.
- withName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStartWorkflowInputParameter.Builder
-
Sets the name of the input parameter for starting a workflow.
- withName(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistRequest.Builder
-
Given a picklist
name
, builds a request for this picklist. - withNewOwnerId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerRequest.Builder
-
Required: sets the ID of the new workflow owner.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
The objectName of the attachment.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionRequest.Builder
-
Deprecated.as of 23R1.3, see
ObjectMetadataService.newFieldCollectionRequestBuilder()
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldRequest.Builder
-
Deprecated.Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataRequest.Builder
-
Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistDependencyRequest.Builder
-
Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionRequest.Builder
-
Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Required: Sets the object name.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
Set the objectName for the request and return the Builder itself.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeRequest.Builder
-
Required: Object name of the records to merge.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The objectName of the attachment.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataRequest.Builder
-
Optional: sets the name of the object associated with the requested object lifecycle.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionRequest.Builder
-
Required: sets the object name of the record to retrieve the object lifecycle metadata fields of.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataRequest.Builder
-
Required: sets the object name of the record to retrieve the object lifecycle metadata fields of.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionMetadataRequest.Builder
-
Required: sets the name of the object associated with the requested object lifecycle user action.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Required: sets the object name for the user action
- withObjectNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionRequest.Builder
-
Optional: sets the object names associated with the requested object lifecycles.
- withObjectRecordId(String) - Method in interface com.veeva.vault.sdk.api.data.DeleteRecordAttachment.Builder
-
The object record ID of the attachment.
- withObjectRecordId(String) - Method in interface com.veeva.vault.sdk.api.data.RecordAttachmentFileReferenceRequest.Builder
-
Set the ID of the record object for the request and return the Builder itself.
- withObjectRecordId(String) - Method in interface com.veeva.vault.sdk.api.data.SaveRecordAttachment.Builder
-
The object record ID of the attachment.
- withObjectRecordId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Required: sets the ID value of the object record to execute the action on
- withObjectTypeIds(List<String>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve object types with the specified ids.
- withObjectTypeName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionRequest.Builder
-
Required: Sets the object type name.
- withObjectTypeName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Optional: sets the name of the object type associated with the object lifecycle stages requested.
- withObjectTypeNames(List<String>) - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve object types with the specified names.
- withObjectTypeNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionRequest.Builder
-
Optional: sets the names of the object types associated with the requested object lifecycle stage groups.
- withOrderBy(List<String>) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
ORDER BY
clause, replacing previously set values. - withParentId(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReplyReadRequest.Builder
-
Required: The ID of the parent annotation to read replies for.
- withParticipantGroupName(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupInputParameter.Builder
-
Required: sets the participant group name.
- withPath(String) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Appends the given path to the base URL.
- withPlacemark(AnnotationPlacemark) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Conditional: Sets the
AnnotationPlacemark
. - withQuery(Query) - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
Sets the VQL
Query
, replacing any previously set Query or query string. - withQuery(Query) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Sets the VQL
Query
, replacing any previously set Query or query string. - withQuery(Query) - Method in interface com.veeva.vault.sdk.api.query.QueryValidationRequest.Builder
-
Sets the VQL
Query
, replacing any previously set Query or query string. - withQueryData(JsonObject) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Required: Sets the query data.
- withQueryDescribe(JsonObject) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Required: Sets the query describe.
- withQueryFacetRequest(QueryFacetRequest) - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
Sets the
QueryFacetRequest
, replacing any previously setQueryFacetRequest
. - withQueryFacetRequest(QueryFacetRequest) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Sets the
QueryFacetRequest
, replacing any previously setQueryFacetRequest
. - withQueryObjectRules(List<String>) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
Sets a specified list of
QueryObjectRule
s for the integration rule query. - withQueryRecordPropertyTypes(List<QueryRecordPropertyType>) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Sets the requested
QueryRecordPropertyType
s, replacing any previously setQueryRecordPropertyType
s. - withQueryString(String) - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
Sets the VQL query string, replacing any previously set query string or
Query
. - withQueryString(String) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Sets the VQL query string, replacing any previously set query string or
Query
. - withQueryString(String) - Method in interface com.veeva.vault.sdk.api.query.QueryValidationRequest.Builder
-
Sets the VQL query string, replacing any previously set query string or
Query
. - withQuerystringParam(String, String) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies a query string param.
- withRecordAttachments(List<DeleteRecordAttachment>) - Method in interface com.veeva.vault.sdk.api.data.BatchDeleteRecordAttachmentRequest.Builder
-
Required: Sets the record attachments to delete.
- withRecordAttachments(List<SaveRecordAttachment>) - Method in interface com.veeva.vault.sdk.api.data.BatchSaveRecordAttachmentRequest.Builder
-
Required: Sets the record attachments to create or update.
- withRecordId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataRequest.Builder
-
Required: sets the ID of the object record to retrieve the object lifecycle metadata fields of.
- withRecordId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionMetadataRequest.Builder
-
Required: sets the ID of the record associated with the requested object lifecycle user action.
- withRecordIds(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionRequest.Builder
-
Required: sets the IDs of the object records to retrieve the object lifecycle metadata fields of.
- withRecordMerges(List<RecordMergeSetInput>) - Method in interface com.veeva.vault.sdk.api.data.RecordMergeRequest.Builder
-
Required: Sets a list of
RecordMergeSetInput
to merge. - withRecords(String, List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionRequest.Builder
-
Optional: sets the list of record IDs to search for any available workflows.
- withRecords(String, List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionRequest.Builder
-
Optional: sets the list of record IDs against which workflows are being executed.
- withRecords(String, List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsRequest.Builder
-
Optional: sets the list of record IDs to remove from the active workflow.
- withRecords(String, List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceRequest.Builder
-
Optional: sets the list of record IDs to search for the specified workflow.
- withRecords(String, List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataRequest.Builder
-
Optional: sets the list of record IDs to search for the specified workflow.
- withRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordBatchDeleteRequest.Builder
-
Required: Sets the list of records to delete in this request.
- withRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordBatchSaveRequest.Builder
-
Required: Sets the list of records to save in this request.
- withRecords(List<Record>) - Method in interface com.veeva.vault.sdk.api.data.RecordDisplayRequest.Builder
-
Required: Sets the list of records to be used for retrieving display values.
- withReferences(List<AnnotationReference>) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Optional: Sets the references associated with this annotation.
- withRequired(boolean) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldFilter.Builder
-
Deprecated.Optional: Sets a filter to retrieve required field attributes only.
- withRequired(boolean) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldFilter.Builder
-
Optional: Sets a filter to retrieve required field attributes only.
- withRequiredOnly() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve required field attributes only.
- withRequiredOnly() - Method in interface com.veeva.vault.sdk.api.data.ObjectTypeFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve required object type fields only.
- withResolveTokens(boolean) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies whether to resolve tokens used in headers, body parameters, and body.
- withRoleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataRequest.Builder
-
Required: sets the object lifecycle role name.
- withRoleNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleRoleMetadataRequest.Builder
-
Optional: Sets the document lifecycle role names for the requested document lifecycle roles.
- withSelect(Collection<String>) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
SELECT
clause, replacing previously set values. - withSkip(long) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
SKIP
clause, replacing any previously set value. - withStageGroupName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataRequest.Builder
-
Required: Sets the name of the document lifecycle stage group associated with the document lifecycle stages to retrieve metadata of.
- withStageGroupName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataRequest.Builder
-
Required: sets the name of the object lifecycle stage group to retrieve metadata of.
- withStageGroupName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Optional: sets the name of the object lifecycle stage group associated with the object lifecycle stages to retrieve metadata of.
- withStageGroupName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataRequest.Builder
-
Required: sets the object lifecycle stage group name for the requested object lifecycle stage.
- withStageGroupNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageGroupMetadataRequest.Builder
-
Required: Sets the names of the document lifecycle stage groups to retrieve metadata of.
- withStageName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataRequest.Builder
-
Required: sets the name of requested object lifecycle stage.
- withStageNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStageMetadataRequest.Builder
-
Optional: Sets the names of requested document lifecycle stages.
- withStartWorkflowInputParameters(String, Object) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Optional: for a Run Workflow user action, sets the input parameter key and value to start the workflow.
- withStartWorkflowInputParameters(List<DocumentLifecycleStartWorkflowInputParameter>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Optional: For a Run Workflow user action, sets the list of input parameters to start the workflow.
- withStateName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionMetadataRequest.Builder
-
Required: Sets the lifecycle state of the document lifecycle associated with the requested document lifecycle user action.
- withStateName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadataRequest.Builder
-
Required: Sets the lifecycle state name associated with the user action of the requested document lifecycle user action user input.
- withStateName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionRequest.Builder
-
Optional: sets the name of the object lifecycle state associated with the object lifecycle stage to retrieve metadata of.
- withStateName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataRequest.Builder
-
Required: sets the object lifecycle state name.
- withStateName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionRequest.Builder
-
Optional: sets the name of the state associated with the object lifecycle state types requested.
- withStateNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStateMetadataRequest.Builder
-
Optional: Sets the document lifecycle state names for the document lifecycle states requested.
- withStateTypeName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataRequest.Builder
-
Required: sets the object lifecycle state type name.
- withStateTypeNames(List<String>) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionRequest.Builder
-
Optional: sets the names of the state types associated with the object lifecycle states requested.
- withSubtype(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document subtype name.
- withSuccessHandler(Consumer<JobCancelResponse>) - Method in interface com.veeva.vault.sdk.api.job.JobCancelOperation
-
Optional: Sets a callback for handling successful job cancellation requests.
- withTargetFieldLookup(boolean) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Optional: Configures the evaluation logic to utilize the
target_field_lookup
attribute to automatically populate an object reference field. - withTargetName(String) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Required: Sets the target name.
- withTimeout(int) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies the maximum time in milliseconds to wait for this HTTP request to complete execution.
- withTitle(String) - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionDialog.Builder
-
Optional: Set the title for this dialog.
- withTokenRequest(TokenRequest) - Method in interface com.veeva.vault.sdk.api.http.HttpWebRequest.Builder
-
Specifies the custom tokens that should be resolved in headers, body parameters, and body.
- withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
Sets the
TokenRequest
andQueryEscapeOverride
(s), replacing any previously setTokenRequest
andQueryEscapeOverride
(s). - withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
Sets the
TokenRequest
andQueryEscapeOverride
(s), replacing any previously setTokenRequest
andQueryEscapeOverride
(s). - withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryValidationRequest.Builder
-
Sets the
TokenRequest
andQueryEscapeOverride
(s), replacing any previously setTokenRequest
andQueryEscapeOverride
(s). - withType(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemarkValueSetRequest.Builder
-
Required: Sets the name of the annotation placemark type associated with the field to retrieve the value set for.
- withType(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReferenceValueSetRequest.Builder
-
Required: Sets the name of the annotation reference type associated with the field to retrieve the value set for.
- withType(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationValueSetRequest.Builder
-
Required: Sets the name of the annotation type associated with the field to retrieve the value set for.
- withType(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document type name.
- withTypeName(String) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Conditional: Sets the name of the annotation type of this annotation.
- withTypeName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemark.Builder
-
Required: Specifies the name of the type of this annotation placemark.
- withTypeName(String) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReference.Builder
-
Required: Specifies the name of the type of this annotation reference.
- withUnique(boolean) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldFilter.Builder
-
Deprecated.Optional: Sets a filter to retrieve unique field attributes only.
- withUniqueField(String) - Method in interface com.veeva.vault.sdk.api.data.RecordBatchSaveRequest.Builder
-
Optional: Sets a unique field for a
RecordService.batchSaveRecords(RecordBatchSaveRequest)
to determine whether an operation is an insert or update without relying on theid
field on theRecord
. - withUniqueOnly() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve unique field attributes only.
- withUserActionName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Required: Sets the name value of the user action.
- withUserActionName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionUserInputMetadataRequest.Builder
-
Required: Sets the user action name associated with the requested document lifecycle user action user input.
- withUserActionName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionInputParameterMetadataRequest.Builder
-
Required: sets the fully qualified user action name associated with the requested object lifecycle user action input parameter.
- withUserActionName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Required: sets the fully qualified name value of the user action.
- withUserIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupInputParameter.Builder
-
Optional: sets the user IDs to add to a participant group.
- withUserIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantInputParameter.Builder
-
Optional: sets a list of user IDs for this participant input.
- withUserInputRecordId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleUserActionExecutionRequest.Builder
-
Optional: For a DocumentAction configured as a user action, sets the record ID for the user_input_object.
- withUserInputRecordId(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.UserActionExecutionRequest.Builder
-
Optional: for a RecordAction configured as a user action, sets the record ID for the user_input_object.
- withValue(Object) - Method in interface com.veeva.vault.sdk.api.lifecycle.DocumentLifecycleStartWorkflowInputParameter.Builder
-
Sets the value of the input parameter for starting a workflow.
- withValue(String, Object) - Method in interface com.veeva.vault.sdk.api.annotation.Annotation.Builder
-
Conditional: Specifies the value of a field with the given API name.
- withValue(String, Object) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationPlacemark.Builder
-
Required: Specifies the value of a field with the given name.
- withValue(String, Object) - Method in interface com.veeva.vault.sdk.api.annotation.AnnotationReference.Builder
-
Required: Specifies the value of a field with the given name.
- withValue(String, Object) - Method in interface com.veeva.vault.sdk.api.token.TokenRequest.Builder
-
Sets a custom value for a specified token.
- withWhere(String) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the
WHERE
clause, replacing previously set values. - withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowAddParticipantsRequest.Builder
-
Required: sets the active workflow ID.
- withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowCancelRequest.Builder
-
Required: sets the active workflow id.
- withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceRequest.Builder
-
Required: set the workflow ID to search for.
- withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowRemoveItemsRequest.Builder
-
Required: sets the active workflow ID.
- withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowReplaceOwnerRequest.Builder
-
Required: sets the active workflow ID.
- withWorkflowId(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowUpdateDueDateRequest.Builder
-
Required: sets the active workflow ID.
- withWorkflowIds(List<String>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionRequest.Builder
-
Optional: sets the workflow IDs to search for those workflows.
- withWorkflowName(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceRequest.Builder
-
Required: adds the specified workflow name to search with.
- withWorkflowName(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataRequest.Builder
-
Required: adds the specified workflow name to search with.
- WORKFLOW_CANCEL - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action supports use as a workflow cancellation action.
- WORKFLOW_STEP - Enum constant in enum class com.veeva.vault.sdk.api.action.Usage
-
The action supports use in an object workflow system step.
- WorkflowAction - Enum Class in com.veeva.vault.sdk.api.workflow
-
Actions that can be executed on an active workflow.
- WorkflowActionError - Interface in com.veeva.vault.sdk.api.workflow
-
Represents an error encountered during a workflow action such as an
WorkflowCancelOperation
. - WorkflowActionResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Contains methods to retrieve information about the workflow action.
- WorkflowAddParticipantsOperation - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow add participants execution operation that can be executed with
WorkflowAddParticipantsOperation.execute()
. - WorkflowAddParticipantsRequest - Interface in com.veeva.vault.sdk.api.workflow
-
A workflow add participants request containing an active workflow instance, the participant group name, and a user or group ID.
- WorkflowAddParticipantsRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowAddParticipantsRequest
. - WorkflowCancelOperation - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow cancel execution operation that can be executed with
WorkflowCancelOperation.execute()
. - WorkflowCancelRequest - Interface in com.veeva.vault.sdk.api.workflow
-
A workflow cancel request containing an active workflow instance and cancellation comment, if required.
- WorkflowCancelRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowCancelRequest
. - WorkflowConfiguration - Interface in com.veeva.vault.sdk.api.workflow
-
Represents the configured workflow definition.
- WorkflowEvent - Enum Class in com.veeva.vault.sdk.api.workflow
-
Events surrounding workflow execution.
- WorkflowInputValueType<T> - Interface in com.veeva.vault.sdk.api.workflow
-
Type of data supported by
WorkflowParameterMetadata
. - WorkflowInstance - Interface in com.veeva.vault.sdk.api.workflow
-
Represents a runtime instance of a workflow.
- WorkflowInstanceCollectionRequest - Interface in com.veeva.vault.sdk.api.workflow
-
Retrieve a list of
WorkflowInstance
s for the given list of document IDs, record IDs, or workflow IDs. - WorkflowInstanceCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds an
WorkflowInstanceCollectionRequest
, used to retrieveWorkflowInstance
s. - WorkflowInstanceCollectionResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Holds a list of
WorkflowInstance
s. - WorkflowInstanceRequest - Interface in com.veeva.vault.sdk.api.workflow
-
Retrieve the
WorkflowInstance
for the given workflow ID. - WorkflowInstanceRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowInstanceRequest
, used to retrieveWorkflowInstance
s. - WorkflowInstanceService - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to retrieve information for and update workflow instances.
- WorkflowItem - Interface in com.veeva.vault.sdk.api.workflow
-
Represents an item that a workflow is executing on.
- WorkflowItemDocument - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to retrieve metadata information of a document item in a workflow.
- WorkflowItemRecord - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to retrieve metadata information of a record item in a workflow.
- WorkflowItemsResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Response from a call to
WorkflowInstanceService.getWorkflowItems(String)
- WorkflowItemType - Enum Class in com.veeva.vault.sdk.api.workflow
-
Types of items a workflow can execute on.
- WorkflowMetadataService - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to interact with workflow metadata.
- WorkflowParameterMetadata - Interface in com.veeva.vault.sdk.api.workflow
-
Holds the info for a parameter metadata needed to interact with the workflow.
- WorkflowParticipantGroup - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to retrieve information for a participant group of an active workflow.
- WorkflowParticipantGroupInputParameter - Interface in com.veeva.vault.sdk.api.workflow
-
Container for a workflow participant group input parameter.
- WorkflowParticipantGroupInputParameter.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowParticipantGroupInputParameter
. - WorkflowParticipantGroupResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Response from a call to
WorkflowInstanceService.getWorkflowParticipantGroups(String)
. - WorkflowParticipantGroupUpdate - Interface in com.veeva.vault.sdk.api.workflow
-
Sets the information needed to perform updates for a
WorkflowParticipantGroup
of an active workflow. - WorkflowParticipantInputParameter - Interface in com.veeva.vault.sdk.api.workflow
-
Container for a workflow participant input parameter.
- WorkflowParticipantInputParameter.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowParticipantInputParameter
. - WorkflowRemoveItemsOperation - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow remove items execution operation that can be executed with
WorkflowRemoveItemsOperation.execute()
. - WorkflowRemoveItemsRequest - Interface in com.veeva.vault.sdk.api.workflow
-
A workflow remove items request containing an active workflow instance, and a list of document or record IDs.
- WorkflowRemoveItemsRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowRemoveItemsRequest
. - WorkflowRemoveItemsResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Contains methods to retrieve information specific to the remove items workflow action.
- WorkflowReplaceOwnerOperation - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow replace owner execution operation that can be executed with
WorkflowReplaceOwnerOperation.execute()
. - WorkflowReplaceOwnerRequest - Interface in com.veeva.vault.sdk.api.workflow
-
A workflow replace owner request containing an active workflow instance and the id of the new workflow owner.
- WorkflowReplaceOwnerRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowReplaceOwnerRequest
. - WorkflowRequestExecutionContext - Interface in com.veeva.vault.sdk.api.workflow
-
Contains metadata about the current workflow request.
- WorkflowStartInstanceError - Interface in com.veeva.vault.sdk.api.workflow
-
Represents an error encountered during a
WorkflowStartInstanceOperation
. - WorkflowStartInstanceOperation<T> - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow start execution operation that can be executed with
WorkflowStartInstanceOperation.execute()
. - WorkflowStartInstanceRequest - Interface in com.veeva.vault.sdk.api.workflow
-
Request to start a workflow with the given workflow name and list of documents or record IDs and input parameters.
- WorkflowStartInstanceRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowStartInstanceRequest
. - WorkflowStartInstanceResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Contains methods to retrieve information about the result of the workflow start action.
- WorkflowStartMetadataRequest - Interface in com.veeva.vault.sdk.api.workflow
-
Request to get metadata to start a workflow with the given workflow name and list of documents or record IDs.
- WorkflowStartMetadataRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowStartMetadataRequest
. - WorkflowStartMetadataResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Holds the basic info for the specified workflow and the list of
WorkflowStartStepMetadata
needed to start the workflow. - WorkflowStartStepMetadata - Interface in com.veeva.vault.sdk.api.workflow
-
Holds the basic info of the start step metadata and a list of
WorkflowParameterMetadata
. - WorkflowStartStepType - Enum Class in com.veeva.vault.sdk.api.workflow
-
Start step types.
- WorkflowStepType - Enum Class in com.veeva.vault.sdk.api.workflow
-
Types of steps that can exist in a workflow.
- WorkflowTaskChange - Interface in com.veeva.vault.sdk.api.workflow
-
Represents a workflow task that is being modified.
- WorkflowTaskConfiguration - Interface in com.veeva.vault.sdk.api.workflow
-
Contains information about the workflow task step configuration.
- WorkflowTaskInstance - Interface in com.veeva.vault.sdk.api.workflow
-
Represents a workflow task instance created from execution of a task step.
- WorkflowTaskQueryParameters - Interface in com.veeva.vault.sdk.api.workflow
-
Provides a mechanism to filter workflow task instances.
- WorkflowTaskService - Interface in com.veeva.vault.sdk.api.workflow
-
Provides methods to retrieve and perform updates for tasks of an active workflow.
- WorkflowTaskStatus - Enum Class in com.veeva.vault.sdk.api.workflow
-
Statuses a workflow task instance can be in.
- WorkflowType - Enum Class in com.veeva.vault.sdk.api.workflow
-
Supported workflow types.
- WorkflowUpdateDueDateOperation - Interface in com.veeva.vault.sdk.api.workflow
-
A sequence of instructions that can be chained together, building a workflow update due date execution operation that can be executed with
WorkflowUpdateDueDateOperation.execute()
. - WorkflowUpdateDueDateRequest - Interface in com.veeva.vault.sdk.api.workflow
-
A workflow update due date request containing an active workflow instance and new due date.
- WorkflowUpdateDueDateRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
Builds a
WorkflowUpdateDueDateRequest
.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
RecordService.batchDeleteRecords(RecordBatchDeleteRequest)