All Classes and Interfaces
Class
Description
Error types that can occur during SDK action execution.
Represents a document annotation.
Creates an instance of
Annotation
.Represents a positional error result for batch delete operations calls from
AnnotationService
, indicating that
one of the inputs in the batch failed.Provides data about an error included in the response of batch delete operations provided by
AnnotationService
, including the error message and type.Represents the error types included in the response of batch delete operations provided by
AnnotationService
when a particular input fails with an error.Represents a request to delete multiple annotations by providing a
List
of annotation IDs.Creates an instance of
AnnotationBatchDeleteRequest
.Represents a positional error result for batch save operations calls from
AnnotationService
, indicating that
one of the inputs in the batch failed.Provides data about an error included in the response of batch save operations provided by
AnnotationService
, including the error message and type.Represents error types included in the response of batch save operations provided by
AnnotationService
when a particular input fails with an error.Represents a request to create or update multiple annotations by providing a
List
of Annotation
s.Creates an instance of
AnnotationBatchSaveRequest
.Represents the result of processing an
AnnotationService.batchSaveAnnotations(AnnotationBatchSaveRequest)
,
indicating that one of the Annotation
s passed in the batch successfully created at least one resulting
annotation.Provides methods to retrieve common metadata information of the specified annotation field.
Provides methods to retrieve the metadata of an
AnnotationField
.Creates an instance of
AnnotationFieldRequest
.Provides methods to retrieve metadata about annotation types, annotation fields, placemark types, placemark fields,
reference types, and reference fields.
Represents an annotation placemark and provides methods to retrieve field values and type names for any
annotation placemark type.
Creates an instance of
AnnotationPlacemark
.Provides methods to retrieve common metadata information of the specified annotation placemark field.
Retrieves an instance of
AnnotationPlacemarkField
to build the request for retrieving annotation placemark
field metadata.Creates an instance of
AnnotationPlacemarkFieldRequest
.Provides methods to retrieve common metadata information of the specified annotation placemark type.
Retrieves an instance of
AnnotationPlacemarkType
to build the request for retrieving annotation placemark
type metadata.Creates an instance of
AnnotationPlacemarkTypeRequest
.Used to request the value set of an
AnnotationPlacemarkField
on a particular AnnotationPlacemarkType
.Creates an instance of
AnnotationPlacemarkValueSetRequest
.Types of data supported by
AnnotationPlacemark
s.Represents an error included in the response of read operations provided by
AnnotationService
.Error types that may occur during read operations provided by
AnnotationService
when a
request fails with an error.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()
.Requests to read multiple annotations by providing either a
List
of unique annotation IDs or a document
version ID to read annotations from.A builder for an
AnnotationReadRequest
, including filters on the request.Response from a call to
AnnotationService.readAnnotations(AnnotationReadRequest)
.Represents an annotation reference.
Creates an instance of
AnnotationReference
.Provides methods to retrieve common metadata information of the specified annotation reference field.
Used to request the metadata of an
AnnotationReferenceField
.Creates an instance of
AnnotationReferenceFieldRequest
.Provides methods to retrieve common metadata information of the specified annotation reference type.
Used to request the metadata of an
AnnotationReferenceType
.Creates an instance of
AnnotationReferenceTypeRequest
.Used to request the value set of an
AnnotationReferenceField
on a particular AnnotationReferenceType
.Creates an instance of
AnnotationReferenceValueSetRequest
.Types of data supported by
AnnotationReference
s.Requests to read the replies of a given parent annotation.
Creates an instance of
AnnotationReplyReadRequest
.Provides methods to manage document annotations in Vault.
Provides methods to retrieve common metadata information of the specified annotation type.
Used to request the metadata of an
AnnotationType
.Creates an instance of
AnnotationTypeRequest
.Used to request the value set of an
AnnotationField
on a particular AnnotationType
.Creates an instance of
AnnotationValueSetRequest
.Types of data supported by
Annotation
s.Response from a call to
WorkflowInstanceService.getAvailableWorkflowInstanceActions(WorkflowInstanceRequest)
.Holds basic metadata of an available workflow.
Request to retrieve a list of
AvailableWorkflowMetadata
for the given list of documents or record IDs.Holds a list of
AvailableWorkflowMetadata
.The request object for deleting a list of attachments for the specified object.
Creates an instance of
BatchDeleteRecordAttachmentRequest
.A sequence of instructions that can be chained together,
building up a final operation which can be
executed with
BatchOperation.execute()
.Retrieves batch operation errors for a particular input List position.
Base interface to be used as a response to batch operations.
Contains the payload of one or more manually matched documents to remove from an EDL Item.
Creates an instance of
BatchRemoveMatchedDocumentsRequest
.Contains the payload of one or more matched documents to save to an EDL Item.
Creates an instance of
BatchSaveMatchedDocumentsRequest
.The request object for creating or updating a list of attachments for the specified object.
Creates an instance of
BatchSaveRecordAttachmentRequest
.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.
Represents contextual information for the connection established with
ConnectionService
.Provides methods to build a new connection context for use with
DocumentService
.Valid users to establish a connection to at least one Vault.
Builds
CsvData
.Represents immutable CSV data.
The headers (column names) for CSV data.
Parameters that define the format of the CSV being read.
Service for reading and writing CSV data.
Types that can be read from or written to CSV data.
Parameters that define the format of the CSV being written.
A container for a default value expression.
Response from a call to
DocumentService.deleteDocumentVersions(List)
(List)}.Provides methods to delete a record attachment.
Creates an instance of
DeleteRecordAttachment
.Deprecated.
Executes a given document action; takes
DocumentActionContext
as input.Contains contextual data about a document action during execution.
Indicates a class is a document action.
Represents the target attachment.
Represents an attachment file from the current or from another Vault.
Provides methods to retrieve common metadata information of the specified document field.
Retrieves a List of all fields in the
DocumentField
collection once a request is built for the given document type.Creates an instance of
DocumentFieldCollectionRequest
.Holds a
DocumentField
collection.Provides methods to retrieve required, unique, all, or a specific subset of document fields.
Creates an instance of
DocumentFieldFilter
.A list of all of the possible field types that a document field can be.
Represents a document file from the current or from another Vault.
Provides methods to retrieve metadata fields for a specific document lifecycle.
Represents a request to retrieve multiple document lifecycles in the format of
DocumentLifecycleMetadata
collection.Creates an instance of
DocumentLifecycleMetadataRequest
.Holds a
DocumentLifecycleMetadata
collection.Provides methods to retrieve document lifecycle, state, stage group, stage, and role metadata.
Provides methods to retrieve metadata fields for a specific document lifecycle role.
Represents a request to retrieve multiple document lifecycle roles in the format of
DocumentLifecycleRoleMetadata
collection.Creates an instance of
DocumentLifecycleRoleMetadataRequest
.Holds a
DocumentLifecycleRoleMetadata
collection.Provides methods to retrieve metadata fields for a specific document lifecycle stage group.
Represents a request to retrieve multiple document lifecycle stage groups in the format of
DocumentLifecycleStageGroupMetadata
collection.Creates an instance of
DocumentLifecycleStageGroupMetadataRequest
.Holds a
DocumentLifecycleStageGroupMetadata
collection.Provides methods to retrieve metadata fields for a specific document lifecycle stage.
Represents a request to retrieve multiple document lifecycle stages in the format of
DocumentLifecycleStageMetadata
collection.Creates an instance of
DocumentLifecycleStageMetadataRequest
.Holds a
DocumentLifecycleStageMetadata
collection.Container for input parameters necessary to execute a Run Workflow document lifecycle user action.
Creates an instance of
DocumentLifecycleStartWorkflowInputParameter
.Provides methods to retrieve metadata fields for a specific document lifecycle state.
Represents a request to retrieve multiple document lifecycle states in the format of
DocumentLifecycleStateMetadata
collection.Creates an instance of
DocumentLifecycleStateMetadataRequest
.Holds a
DocumentLifecycleStateMetadata
collection.Provides methods to retrieve metadata about document lifecycle user action, document version lifecycle user action,
and user action user input.
Provides methods to execute a document lifecycle user action.
Represents an error encountered during a
DocumentLifecycleUserActionExecutionOperation
.A sequence of instructions that can be chained together, building a document lifecycle user action execution operation
that can be executed with
DocumentLifecycleUserActionExecutionOperation.execute()
.Provides methods to set the parameters necessary to execute a document lifecycle user action.
Creates an instance of
DocumentLifecycleUserActionExecutionRequest
.Represents the result of the execution of a document lifecycle user action.
Provides methods to retrieve metadata fields for a specific document lifecycle user action.
Represents a request to retrieve metadata about document lifecycle user actions in the format of
DocumentLifecycleUserActionMetadataResponse
.Creates an instance of
DocumentLifecycleUserActionMetadataRequest
.Holds a
DocumentLifecycleUserActionMetadata
collection.Provides methods to retrieve metadata fields for a specific document action's input.
Represents a request to retrieve user action user input metadata, in the format of
DocumentLifecycleUserActionUserInputMetadata
.Creates an instance of
DocumentLifecycleUserActionUserInputMetadataRequest
.Provides methods to retrieve document type and document field metadata.
Represents the target document-version rendition.
Represents a document-version rendition file from the current or from another Vault.
Provides methods to retrieve information in a
DocumentRole
.Provides methods to read and update
DocumentRole
s.Provides methods to add or remove users and groups in a
DocumentRole
.Provides methods to update and delete documents.
Represents a document-version source file from the current or from another Vault.
Provides methods to retrieve common metadata information of the specified document type.
A list of all possible levels a
DocumentType
can be.Retrieves an instance of
DocumentType
to build the request for retrieving document type metadata.Creates an instance of
DocumentTypeRequest
.Represents a document version.
Represents the metadata associated with a lifecycle user action for a particular document version.
Represents a request to retrieve metadata about document lifecycle user actions on a specific document version
in the format of
DocumentVersionLifecycleUserActionMetadataResponse
.Creates an instance of
DocumentVersionLifecycleUserActionMetadataRequest
.Holds a
DocumentVersionLifecycleUserActionDetail
collection.Represents an email address.
Represents the body type of an email.
Represents a file attached to an email.
Represents a single email.
Invoked to process an email received by the Vault Email Service.
Provides access to contextual information exposed in an Email Processor.
Indicates a class is an
EmailProcessor
.Represents the recipient of the email.
Represents the sender of the email.
Represents the types of senders from whom an email processor can receive emails.
A service to interact with emails received by Vault.
Provides a method to set an error record in Vault.
Represents an error.
Provides the data needed to evaluate a field rule; built from
EvaluateFieldRulesRequestBuilder
.Provides methods to build an
EvaluateFieldRulesRequest
; built from
IntegrationRuleService.newEvaluateFieldRulesRequestBuilder()
.Provides methods to retrieve information about an evaluated field rule; returned from
IntegrationRuleService.evaluateFieldRules(EvaluateFieldRulesRequest)
.Indicates whether a
RecordEvent
or RecordRoleEvent
occurs before or after an event-specific
occurrence.For internal Veeva use only.
A container for an expression.
Provides methods to retrieve information related to a FieldRule.
Provides methods to retrieve the error type and message associated with a field rule.
Provides methods to retrieve information after evaluating a field rule.
Common interface for all field types.
Represents a file location in either the current Vault or in a different
Vault.
A container for a format mask expression.
A HttpRequest replacing
HttpRequest
Provides methods to retrieve
DocumentRole
, returned from DocumentRoleService.getDocumentRoles(List, String)
.Provides methods to check if a particular group is assigned to a given document role, returned from
DocumentRoleService.getGroupInDocumentRoles(Group, List)
.Provides methods to check group membership in a
RecordRole
, returned from
RecordRoleService.getGroupInRecordRoles(Group, List)
.Provides methods to retrieve Groups.
Provides the data needed to retrieve a specific set of integration rules; built from
GetIntegrationRulesRequestBuilder.build()
.Provides methods to build a
GetIntegrationRulesRequest
; built from
IntegrationRuleService.newGetIntegrationRulesRequestBuilder()
.Provides methods to retrieve information associated with an integration rule; returned from
IntegrationRuleService.getIntegrationRules(GetIntegrationRulesRequest)
.Provides methods to check which users or documents are missing assignments in a particular role.
Provides methods to check which users or records are missing assignments in a particular role.
Provides methods to retrieve
RecordRole
s, returned from RecordRoleService.getRecordRoles(List, String)
.Provides methods to check if a particular user is assigned to a given document role.
Provides methods to check user membership in RecordRole.
Provides methods to retrieve group related information.
Provides methods to retrieve
GetGroupsResponse
and check user membership in group.Valid values for group classifications.
Valid values for HTTP methods.
A sequence of instructions that can be chained together,
building up a final operation which can be
executed with
HttpOperation.execute()
.Represents an HTTP operation error.
Valid values for errors on HTTP request execution.
Represents an HTTP request.
Supported values for the Content-Type header in an
HttpRequest
, which can be set using
HttpRequest.setContentType(com.veeva.vault.sdk.infrastructure.http.HttpRequestContentEnumType)
.Represents an HTTP request execution response.
Types of data supported by an HTTP response body.
Provides methods to make HTTP requests.
Set of tokens built-in to
HttpService
that will be resolved for HttpRequest
s that have token
resolution enabled.A HttpRequest super interface that is required to be extended in sdk for different HttpRequest
Provides methods to retrieve information related to an
IntegrationRule
.Provides methods to retrieve the error type and message associated with an integration rule.
Represents an integration rule query, which you can include in a VQL query string and submit through
HttpService
.Creates an instance of
IntegrationRuleQuery
.Provides methods to retrieve and evaluate integration rules.
Valid integration and field rule item error types.
Invoked by
JobService
to start a Job with the Vault Java SDK.A sequence of instructions that can be chained together,
building a job cancellation operation which can be executed with
JobCancelOperation.execute()
.Represents an unsuccessful attempt to cancel a job.
Valid values for error types encountered during job cancellation.
Represents a job cancellation request which can be submitted
through
JobService.cancel(JobCancelRequest)
.Creates a new instance of
JobCancelRequest
.Represents a successful attempt to cancel a job.
Context given to
Job
's complete methods.Contains contextual information about the current job.
Indicates a class is a job processor.
Context given to
Job.init(JobInitContext)
.An object returned by
Job.init(com.veeva.vault.sdk.api.job.JobInitContext)
which allows the job to be chunked and processed correctly.Contains data about a single item in a
Job
.Allows logging to the job log file.
Contains information about a job's owner.
Valid values for the job owner type, either a single user or a group.
Provides methods to set values for job parameters.
An interface to store data in a job context.
Type of data supported by the Vault Java SDK for job parameters set on
JobParameters
when invoking a job
through JobService
.Context given to
Job.process(JobProcessContext)
.Contains information about a
Job
's task results.Contains information about a job started through
JobService.runJob(JobParameters)
.Service interface to run jobs with specified parameters.
Provides methods to get task information.
An interface to store data in a job context.
Type of data supported by the Vault Java SDK for parameters setting via
Job.init(JobInitContext)
and
Job.process(JobProcessContext)
.Represents a JSON array.
Builds
JsonArray
instances.Represents immutable JSON.
Represents a JSON object.
Builds
JsonObject
instances.Represents a property of a
JsonObject
.Service for reading and writing JSON data.
Types that can be read from or written to JSON data.
Provides methods to retrieve role information for a document or object lifecycle.
Line endings supported while reading/writing CSVs.
Send messages to the Vault Java SDK Logs, available in Admin > Logs > Vault Java SDK Logs.
Represents an error that occurred while processing one provided matched document in the batch request.
Provides data about the error included in a
MatchedDocumentService
batch
operation response, including the error message and type.Valid values for error types when using methods in
MatchedDocumentService
.Contains information about one processed matched document, including the EDL Item ID and document version ID.
Provides methods to batch save and remove automatically and manually matched documents.
Custom batch operation response interface for the
MatchedDocumentService
batch methods.Represents the result of successfully processing one provided matched document in the batch request.
Provides methods to update the content of a Spark message.
Type of data supported by the Vault Java SDK.
Contains contextual information about a Message.
Provides methods to retrieve the failure type and error message of the failed Spark message delivery.
Error types that may occur when sending a Spark message.
Provides methods to override default behavior for handling failed Spark message deliveries.
Retrieves the context and delivery error of the failed Spark message delivery.
Indicates a class is a
MessageDeliveryEventHandler
.Retrieves the context and sets tokens for the outbound Spark message.
Valid integration and field rule message error types.
Invoked to process a message received by an inbound queue.
Indicates a class is a
MessageProcessor
.Set the subject, message, and text to use in a notification.
Valid methods to send a notification.
Set the recipients, sender, and other notification options.
Send Vault notifications.
Set the template and tokens to resolve for a notification.
Provides methods to retrieve common metadata on Boolean fields.
Provides methods to retrieve common metadata on component fields.
Provides methods to retrieve common metadata on currency fields.
Provides methods to retrieve common metadata on date fields.
Provides methods to retrieve common metadata on DateTime fields.
Provides methods to retrieve common metadata on document reference fields.
A list of all possible types for an
ObjectDocumentReferenceFieldMetadata
.Deprecated.
as of 23R1.3, see
ObjectMetadataService.getField(ObjectFieldRequest)
Deprecated.
as of 23R1.3, see
ObjectMetadataService.newFieldCollectionRequestBuilder()
Creates an instance of
ObjectFieldCollectionRequest
.Deprecated.
as of 23R1.3, see
ObjectMetadataService.getFields(ObjectFieldCollectionRequest)
Deprecated.
as of 23R1.3, see
ObjectMetadataService.newFieldCollectionRequestBuilder()
Creates an instance of
ObjectFieldFilter
.Provides methods to retrieve common metadata on the specified object field.
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.Holds an
ObjectFieldMetadata
collection.A list of the possible object field types.
Deprecated.
as of 23R1.3, see
ObjectMetadataService.newFieldRequestBuilder()
Deprecated.
as of 23R1.3, see
ObjectMetadataService.newFieldRequestBuilder()
A list of all possible object field types.
Provides methods to retrieve common metadata on Boolean formula fields.
Provides methods to retrieve common metadata on currency formula fields.
A list of all possible currency types for currency formula fields.
Provides methods to retrieve common metadata on date formula fields.
Provides methods to retrieve common metadata on DateTime formula fields.
A container for a formula field expression.
Provides methods to retrieve common metadata on formula fields.
A list of all possible missing field behavior types for a formula field.
A list of all possible return types for a formula field.
A representation of a typed formula field.
Provides methods to retrieve common metadata on icon formula fields.
Provides methods to retrieve common metadata on link formula fields.
Provides methods to retrieve common metadata on number formula fields.
Provides methods to retrieve common metadata on text formula fields.
Provides methods to retrieve common metadata on ID fields.
Provides methods to retrieve metadata fields for a specific object lifecycle.
Represents a request to retrieve multiple object lifecycles in the format of
ObjectLifecycleMetadata
collection.Creates an instance of
ObjectLifecycleMetadataCollectionRequest
.Holds an
ObjectLifecycleMetadata
collection.Represents a request to retrieve a single object lifecycle in the format of
ObjectLifecycleMetadata
.Creates an instance of
ObjectLifecycleMetadataRequest
.Provides methods to retrieve object lifecycle, state, state type, stage group, and stage metadata.
Provides methods to retrieve metadata fields for a specific object lifecycle role.
Represents a request to retrieve multiple object lifecycle roles in the format of
ObjectLifecycleRoleMetadata
collection.Creates an instance of
ObjectLifecycleRoleMetadataCollectionRequest
.Holds an
ObjectLifecycleRoleMetadata
collection.Represents a request to retrieve a single object lifecycle role in the format of
ObjectLifecycleRoleMetadata
.Creates an instance of
ObjectLifecycleRoleMetadataRequest
.Provides methods to retrieve metadata fields for a specific object lifecycle stage group.
Represents a request to retrieve multiple object lifecycle stage groups in the format of
ObjectLifecycleStageGroupMetadata
collection.Creates an instance of
ObjectLifecycleStageGroupMetadataCollectionRequest
.Holds an
ObjectLifecycleStageGroupMetadata
collection.Represents a request to retrieve a single object lifecycle stage group in the format of
ObjectLifecycleStageGroupMetadata
.Creates an instance of
ObjectLifecycleStageGroupMetadataRequest
.Provides methods to retrieve metadata fields for a specific object lifecycle stage.
Represents a request to retrieve multiple object lifecycle stages in the format of
ObjectLifecycleStageMetadata
collection.Creates an instance of
ObjectLifecycleStageMetadataCollectionRequest
.Holds an
ObjectLifecycleStageMetadata
collection.Represents a request to retrieve a single object lifecycle stage in the format of
ObjectLifecycleStageMetadata
.Creates an instance of
ObjectLifecycleStageMetadataRequest
.Provides methods to retrieve metadata fields for a specific object lifecycle state.
Represents a request to retrieve multiple object lifecycle states in the format of
ObjectLifecycleStateMetadata
collection.Creates an instance of
ObjectLifecycleStateMetadataCollectionRequest
.Holds an
ObjectLifecycleStateMetadata
collection.Represents a request to retrieve a single object lifecycle state in the format of
ObjectLifecycleStateMetadata
.Creates an instance of
ObjectLifecycleStateMetadataRequest
.Provides methods to retrieve metadata fields for a specific object lifecycle state type.
Represents a request to retrieve multiple object lifecycle state types in the format of
ObjectLifecycleStateTypeMetadata
collection.Creates an instance of
ObjectLifecycleStateTypeMetadataCollectionRequest
.Holds an
ObjectLifecycleStateTypeMetadata
collection.Represents a request to retrieve a single object lifecycle state type in the format of
ObjectLifecycleStateTypeMetadata
.Creates an instance of
ObjectLifecycleStateTypeMetadataRequest
.Provides methods to retrieve metadata about an object lifecycle user action.
Provides methods to execute an object lifecycle user action.
Holds an
ObjectLifecycleUserActionMetadata
collection.Provides methods to retrieve metadata fields for a specific object action's input object.
Representation of a request to retrieve metadata about user action input parameters, in the format of
ObjectLifecycleUserActionInputParameterMetadata
.Provides methods to retrieve metadata fields for a specific object lifecycle user action.
Representation of a request to retrieve metadata about user actions, in the format of
ObjectRecordLifecycleUserActionCollectionResponse
.Provides methods to retrieve common metadata on long text fields.
Provides methods to retrieve common metadata on Boolean lookup fields.
Provides methods to retrieve common metadata on component lookup fields.
Provides methods to retrieve common metadata on currency lookup fields.
Provides methods to retrieve common metadata on date lookup fields.
Provides methods to retrieve common metadata on DateTime lookup fields.
Provides methods to retrieve common metadata on lookup fields.
A list of all possible field types for a lookup field.
A representation of a typed lookup field.
Provides methods to retrieve common metadata on ID lookup fields.
Provides methods to retrieve common metadata on long text lookup fields.
Provides methods to retrieve common metadata on number lookup fields.
Provides methods to retrieve common metadata on object reference lookup fields.
Provides methods to retrieve common metadata on parent reference lookup fields.
Provides methods to retrieve common metadata on picklist lookup fields.
Provides methods to retrieve common metadata on rich text lookup fields.
Provides methods to retrieve common metadata on text lookup fields.
Provides methods to retrieve common metadata for the specified object.
Represents the data store type of an object.
A list of all possible join types for objects.
Retrieves an instance of
ObjectMetadata
to build the request for retrieving object metadata.Creates an instance of
ObjectMetadataRequest
.Provides methods to retrieve object and object-field metadata.
Provides methods to retrieve common metadata on number fields.
Provides methods to retrieve common metadata on parent reference fields.
Provides methods to retrieve object picklist dependency metadata.
Retrieves an instance of
ObjectPicklistDependency
to build the request for retrieving object picklist dependency metadata.Creates an instance of
ObjectPicklistDependencyRequest
.Holds an
ObjectPicklistDependency
collection.Provides methods to retrieve common metadata on picklist fields.
Provides methods to retrieve object lifecycle metadata fields for a specific object record.
Represents a request to retrieve the object lifecycle metadata fields of multiple object records in the format
of
ObjectRecordLifecycleMetadata
collection.Creates an instance of
ObjectRecordLifecycleMetadataCollectionRequest
.Holds an
ObjectRecordLifecycleMetadata
collection.Represents a request to retrieve the object lifecycle metadata fields of a single object record in the format
of
ObjectRecordLifecycleMetadata
.Creates an instance of
ObjectRecordLifecycleMetadataRequest
.Holds an
ObjectRecordLifecycleUserActionDetail
collection.Represents the metadata associated with a lifecycle user action for a particular record.
Provides methods to retrieve common metadata on reference fields.
A list of all possible delete types for reference fields.
Provides methods to retrieve common metadata on rich text fields.
Provides methods to retrieve common metadata on text fields.
Provides methods to retrieve common metadata on Boolean object type fields.
Provides methods to retrieve common metadata on component object type fields.
Provides methods to retrieve common metadata on currency object type fields.
Provides methods to retrieve common metadata on date object type fields.
Provides methods to retrieve common metadata on DateTime object type fields.
Provides methods to retrieve common metadata on document reference object type fields.
Provides methods to retrieve common metadata for the specified object type field.
Retrieves a List of all object types in the
ObjectTypeFieldMetadata
once a request is built for the given
object and object type.Creates an instance of
ObjectTypeFieldMetadataCollectionRequest
.Holds an
ObjectTypeFieldMetadata
collection.A list of the possible object type field types.
Provides methods to retrieve common object type metadata on Boolean formula fields.
Provides methods to retrieve common object type metadata on currency formula fields.
Provides methods to retrieve common object type metadata on date formula fields.
Provides methods to retrieve common object type metadata on DateTime formula fields.
Provides methods to retrieve common metadata on object type formula fields.
A list of all possible field types for an object type formula field.
A representation of a typed object type formula field.
Provides methods to retrieve common object type metadata on icon formula fields.
Provides methods to retrieve common object type metadata on link formula fields.
Provides methods to retrieve common object type metadata on number formula fields.
Provides methods to retrieve common object type metadata on text formula fields.
Provides methods to retrieve common metadata on ID object type fields.
Provides methods to retrieve common metadata on long text object type fields.
Provides methods to retrieve common object type metadata on Boolean lookup fields.
Provides methods to retrieve common object type metadata on component lookup fields.
Provides methods to retrieve common object type metadata on currency lookup fields.
Provides methods to retrieve common object type metadata on date lookup fields.
Provides methods to retrieve common object type metadata on DateTime lookup fields.
Provides methods to retrieve common metadata on object type lookup fields.
A list of all possible field types for an object type lookup field.
A representation of a typed object type lookup field.
Provides methods to retrieve common object type metadata on ID lookup fields.
Provides methods to retrieve common object type metadata on long text lookup fields.
Provides methods to retrieve common object type metadata on number lookup fields.
Provides methods to retrieve common object type metadata on object lookup fields.
Provides methods to retrieve common object type metadata on parent object lookup fields.
Provides methods to retrieve common object type metadata on picklist lookup fields.
Provides methods to retrieve common object type metadata on rich text lookup fields.
Provides methods to retrieve common object type metadata on text lookup fields.
Provides methods to retrieve common metadata for the specified object type.
Retrieves a List of all object types in the
ObjectTypeMetadata
once a request is built for the given object.Creates an instance of
ObjectTypeMetadataCollectionRequest
.Holds an
ObjectTypeMetadata
collection.Provides methods to retrieve common metadata on number object type fields.
Provides methods to retrieve common metadata on object reference object type fields.
Provides methods to retrieve common metadata on parent reference object type fields.
Provides methods to retrieve common metadata on picklist object type fields.
Provides methods to retrieve common metadata on rich text object type fields.
Provides methods to retrieve common metadata on text object type fields.
Provides methods to retrieve common metadata on unbound document object type fields.
Provides methods to retrieve common metadata on unbound document fields.
Provides information about a picklist.
Request to retrieve a
Picklist
object.Creates an instance of
PicklistRequest
.Service to retrieve picklist information.
Provides access to picklist values, allowing retrieval of labels, status, and name.
Represents a successful result of processing a document in a batch operation, such as a save or delete.
Represents a successful result of processing a record in a batch operation.
Represents the result of processing an input item in a batch operation.
Set UI components during the post-execution phase for a document action
in the
USER_ACTION
use case.Set UI components during the post-execution phase for a record action
in the
USER_ACTION
use case.Set UI components during the post-execution phase for a record
or document action in the
USER_ACTION
use case.Contains additional UI data to be utilized for a record or document action
during the post-execution phase in the
USER_ACTION
use case.Build a
PostExecutionUserActionUIBehavior
with UI data to be set in the action's
onPostExecute
method.Set UI components during the pre-execution phase for a document
action in the
USER_ACTION
use case.Set UI components during the pre-execution phase for a record
action in the
USER_ACTION
use case.Set UI components during the pre-execution phase for a record
or document action in the
USER_ACTION
use case.Contains additional UI data to be utilized for a record or document action
during the pre-execution phase in the
USER_ACTION
use case.Build a
PreExecutionUserActionUIBehavior
with UI data to be set in the action's
onPreExecute
method.The response returned by
QueueService.putMessage(Message)
.Represents the result for a specific connection during
QueueService.putMessage(Message)
.Represents a VQL query.
Creates an instance of
Query
.Represents a VQL count query request which can be submitted through
QueryService.count(QueryCountRequest)
.Creates an instance of
QueryCountRequest
.Represents the result of a count query execution.
Represents the output of
QueryRecordPropertyType.EDITABLE_FIELDS
.Valid overrides for the default escape strategy in a VQL query.
Represents a VQL query request which can be submitted through
QueryService.query(QueryExecutionRequest)
.Creates an instance of
QueryExecutionRequest
.Represents the result of a VQL query execution.
Represents a single row in
QueryExecutionResponse
.Represents a VQL facet request, which can be passed to
QueryExecutionRequest.Builder.withQueryFacetRequest(QueryFacetRequest)
or QueryCountRequest.Builder.withQueryFacetRequest(QueryFacetRequest)
.Creates an instance of
QueryFacetRequest
.Represents the facet response of a query execution.
Represents the result for a single field in a
QueryFacetResponse
.Contains type information for a
QueryFacetResult
.Represents a single value in a
QueryFacetResult
.Represents the output of
QueryRecordPropertyType.HIDDEN_FIELDS
.Represents the output of
QueryRecordPropertyType.HIDDEN_SUBQUERIES
.Valid logical operators for VQL queries.
Provides methods to retrieve information related to a query object rule.
A sequence of instructions that can be chained together,
building a query operation which can be executed with
QueryOperation.execute()
.Represents a VQL query operation error.
Error types that may occur during
QueryOperation
execution.Represents the output of
QueryRecordPropertyType.RECORD_PERMISSIONS
.Represents the output of a
QueryRecordPropertyType
.Valid values for types of record properties to request.
Represents the output of
QueryRecordPropertyType.REDACTED_FIELDS
.Deprecated.
as of 21R3.4, see
QueryService.query(String)
Deprecated.
as of 21R3.4, see
QueryService.query(String)
Service to execute VQL queries.
Valid options to modify the scope of a VQL query target.
Represents a VQL query request which can be validated through
QueryService.validate(QueryValidationRequest)
.Creates an instance of
QueryValidationRequest
.Represents the result of a query validation execution.
Represents attributes of a weblink, as defined in a
hyperlink
function.Represents the output of
QueryRecordPropertyType.WEBLINK_FIELDS
.Valid values for how a weblink opens in a browser tab or window.
Provides methods to create and put messages in a queue.
Response from a call to
RecordService.readRecords(List)
.Represents a Vault object record.
Executes a given record action; takes
RecordActionContext
as input.Contains contextual data about a record action during execution.
Indicates a class is a record action.
Batch Operation to create, update, or delete a batch of record attachment.
Interface for recording the errors of the batch operation for creating, updating, or deleting record attachments.
The error type of batch operation for creating,updating, or deleting record attachments.
Represents an attachment file from the current or another Vault which is a subclass of DocumentFileReference
with additional object related information.
Interfaces for building all the supported file reference for creating attachments for object record.
Creates an instance of
RecordAttachmentFileReferenceRequest
.Provides access to the attachment ID and version ID of the row-level fields for
each entry in the result.
Initiates the result of saving a record attachment.
A delete request designed to contain additional parameters when performing a batch record delete from
RecordService
Creates an instance of
RecordBatchDeleteRequest
Batch Operation to perform on records.
A save request designed to contain additional parameters when performing a batch record save from
RecordService
.Creates an instance of
RecordBatchSaveRequest
.Represents a Record that is being modified.
A request designed to contain records and additional parameters for retrieving the record display values in
RecordDisplayService
.Creates an instance of
RecordDisplayRequest
.Holds a collection of field display values for a record.
Provides methods to retrieve UI display values from records.
Contains valid Event values to specify when the trigger occurs.
Contains valid statuses for merge sets that have completed a merge.
Contains an individual error which occurred when attempting to start a record merge operation.
Input to
RecordMergeEventHandler
methods.Executes custom logic during record merges.
Indicates a class is a
RecordMergeEventHandler
.Starts a record merge.
Contains the List of errors from starting a record merge job.
Contains valid values for error types when starting a record merge.
Response when a record merge job successfully starts.
Request containing data for starting a record merge.
Creates an instance of
RecordMergeRequest
.Represents a merge set to be merged.
Contains information about the merge set, such as which record is main and which is duplicate.
Creates an instance of
RecordMergeSetInput
.Represents the result of attempting to merge a merge set.
Provides methods to retrieve information in a
RecordRole
.Represents changes applied to a record role.
Contains valid Event values to specify when the trigger occurs.
Provides methods to retrieve and update
RecordRole
s.Invoked to start a trigger; takes
RecordRoleTriggerContext
as input.Input to a
RecordRoleTrigger
.Indicates a class is a
RecordRoleTrigger
.Provides methods to perform updates on a
RecordRole
.Provides methods to create, read, update, and delete object records.
Invoked to start a trigger; takes
RecordTriggerContext
as input.Input to a
RecordTrigger
.Indicates a class is a
RecordTrigger
.Executes custom logic on a record during workflow events; takes a
RecordWorkflowActionContext
as input.Contains contextual information about an active workflow during execution.
Indicates a class is a
RecordWorkflowAction
that can be executed against a workflow for an object record.Provides methods to update and retrieve information for tasks of an active workflow.
Valid reference look up types for
Fieldrule
subcomponent under Integrationrule
.Represents a manually matched document to remove from an EDL Item.
Creates an instance of
RemoveMatchedDocument
.Provides access to the context in which the current request is made.
Types of users available in a SDK request.
An interface for implementing a user-defined class to store data in a request context.
Type of data supported by the request context.
Base interface for request execution context.
Provides methods to retrieve application role information.
Exception which, when thrown from Vault Java SDK code, aborts and rolls-back the in-progress transaction.
Represents an immutable row of data in a CSV.
Builds CSV
Row
s.Provides methods for handling the Java SDK runtime.
Response from a call to
DocumentService.saveDocumentVersions(List)
.Represents a matched document to save to an EDL Item.
Creates an instance of
SaveMatchedDocument
.Interface for creating/updating record attachment in the batch operation.
Creates an instance of
SaveRecordAttachment
.Interface for returning the response of executing the batch CUD operations for object record attachments.
Deprecated.
as of 17R2.2, see
RecordService.saveRecords(List)
Marker interface for Vault Java SDK services.
Retrieves an instance of a Vault Java SDK service.
Interface to share between Document Attachment and Record Attachment
when creating a new attachment on either a document or an object record.
A list of the possible field source types.
A utility to access String pattern matching functionality.
Methods to get and set output parameters for a job task.
Contains valid values to define the state of a task.
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.
Builds a
TokenRequest
.Provides input for resolving token values.
Collects resolved values for tokens specified in
TokenResolverInput
.Service to support custom token resolution for supported operations.
Provides methods to retrieve translated Messages in a
Messagegroup
and to replace Message tokens with values.Provides methods to retrieve information about what Messages to read.
Provides methods to build
TranslationsReadRequest
objects.Provides methods to retrieve translated Messages.
Contains valid values for specifying trigger execution order.
Where in Vault the action is available for configuration and execution.
Represents a post-execution banner for a record or document action
in the
USER_ACTION
use case.Build a
UserActionExecutionBanner
to be set on a PostExecutionUserActionUIBehavior
during the action's onPostExecute
method.Represents a pre-execution dialog for a record or document action in the
USER_ACTION
use case.Build a
UserActionExecutionDialog
to be set on a PreExecutionUserActionUIBehavior
during the action's onPreExecute
method.A sequence of instructions that can be chained together, building a user action execution operation that can be executed with
UserActionExecutionOperation.execute()
.Represents an error encountered during a
UserActionExecutionOperation
.Provides methods to set the parameters necessary to execute a User Action.
Represents the result of the execution of a user action.
Provides builders for working pre- and post-execution UI behavior actions
in the
USER_ACTION
use case.Indicates a class is a user-defined class (UDC).
Common interface for all UserDefinedModel objects.
Indicates an interface is a user-defined model (UDM).
Service for handling UserDefinedModel instances.
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 using JsonService
.The Include enum specifies the serialization behavior of a user-defined model.
Marker interface for Vault Java SDK user-defined services.
Indicates an interface is a user-defined service (UDS).
Type of data supported by the Vault Java SDK.
A utility to create JDK Collections and Arrays.
A utility to create
Collector
.Provides access to basic configuration information about the local Vault.
A sequence of instructions that can be chained together,
building up a final operation which can be executed with
VaultInformationOperation.execute()
.Provides access to
VaultInformationOperation
error type and message.Provides methods to retrieve
VaultInformation
.Deprecated.
as of 20R3.4
Actions that can be executed on an active workflow.
Represents an error encountered during a workflow action such as an
WorkflowCancelOperation
.Contains methods to retrieve information about the workflow action.
A sequence of instructions that can be chained together, building a workflow add participants execution operation
that can be executed with
WorkflowAddParticipantsOperation.execute()
.A workflow add participants request containing an active workflow instance, the participant group name, and a user or group ID.
Builds a
WorkflowAddParticipantsRequest
.A sequence of instructions that can be chained together, building a workflow cancel execution operation
that can be executed with
WorkflowCancelOperation.execute()
.A workflow cancel request containing an active workflow instance and cancellation comment, if required.
Builds a
WorkflowCancelRequest
.Represents the configured workflow definition.
Events surrounding workflow execution.
Type of data supported by
WorkflowParameterMetadata
.Represents a runtime instance of a workflow.
Retrieve a list of
WorkflowInstance
s for the given list of document IDs, record IDs, or workflow IDs.Builds an
WorkflowInstanceCollectionRequest
, used to retrieve WorkflowInstance
s.Holds a list of
WorkflowInstance
s.Retrieve the
WorkflowInstance
for the given workflow ID.Builds a
WorkflowInstanceRequest
, used to retrieve WorkflowInstance
s.Provides methods to retrieve information for and update workflow instances.
Represents an item that a workflow is executing on.
Provides methods to retrieve metadata information of a document item in a workflow.
Provides methods to retrieve metadata information of a record item in a workflow.
Response from a call to
WorkflowInstanceService.getWorkflowItems(String)
Types of items a workflow can execute on.
Provides methods to interact with workflow metadata.
Holds the info for a parameter metadata needed to interact with the workflow.
Provides methods to retrieve information for a participant group of an active workflow.
Container for a workflow participant group input parameter.
Builds a
WorkflowParticipantGroupInputParameter
.Response from a call to
WorkflowInstanceService.getWorkflowParticipantGroups(String)
.Sets the information needed to perform updates for a
WorkflowParticipantGroup
of an active workflow.Container for a workflow participant input parameter.
Builds a
WorkflowParticipantInputParameter
.A sequence of instructions that can be chained together, building a workflow remove items execution operation
that can be executed with
WorkflowRemoveItemsOperation.execute()
.A workflow remove items request containing an active workflow instance, and a list of document or record IDs.
Builds a
WorkflowRemoveItemsRequest
.Contains methods to retrieve information specific to the remove items workflow action.
A sequence of instructions that can be chained together, building a workflow replace owner execution operation
that can be executed with
WorkflowReplaceOwnerOperation.execute()
.A workflow replace owner request containing an active workflow instance and the id of the new workflow owner.
Builds a
WorkflowReplaceOwnerRequest
.Contains metadata about the current workflow request.
Represents an error encountered during a
WorkflowStartInstanceOperation
.A sequence of instructions that can be chained together, building a workflow start execution operation
that can be executed with
WorkflowStartInstanceOperation.execute()
.Request to start a workflow with the given workflow name and list of documents or record IDs and input parameters.
Builds a
WorkflowStartInstanceRequest
.Contains methods to retrieve information about the result of the workflow start action.
Request to get metadata to start a workflow with the given workflow name and list of documents or record IDs.
Builds a
WorkflowStartMetadataRequest
.Holds the basic info for the specified workflow and the list of
WorkflowStartStepMetadata
needed to start the workflow.Holds the basic info of the start step metadata and a list of
WorkflowParameterMetadata
.Start step types.
Types of steps that can exist in a workflow.
Represents a workflow task that is being modified.
Contains information about the workflow task step configuration.
Represents a workflow task instance created from execution of a task step.
Provides a mechanism to filter workflow task instances.
Provides methods to retrieve and perform updates for tasks of an active workflow.
Statuses a workflow task instance can be in.
Supported workflow types.
A sequence of instructions that can be chained together, building a workflow update due date execution operation
that can be executed with
WorkflowUpdateDueDateOperation.execute()
.A workflow update due date request containing an active workflow instance and new due date.
Builds a
WorkflowUpdateDueDateRequest
.
RecordService.deleteRecords(List)