- get() - Static method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the context of the current request.
- getAllHeaders() - Method in interface com.veeva.vault.sdk.api.csv.CsvHeaders
-
Returns a list of CSV headers.
- getAllPicklistValues() - Method in interface com.veeva.vault.sdk.api.picklist.Picklist
-
- getAssigneeId() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the user ID of the assignee.
- getAttribute(String, MessageAttributeValueType<T>) - Method in interface com.veeva.vault.sdk.api.queue.Message
-
- 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
-
- getBaseFieldMetadata() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldTypeMetadata
-
- 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.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.
- 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
-
- 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
-
- 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.
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectBooleanFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectDateFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectDateTimeFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectLongTextFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectRichTextFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
- getDefaultValueExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectUnboundDocumentFieldMetadata
-
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadata
-
Retrieves the description, in the current user's language, of this object lifecycle.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the description, in the current user's language, of this object lifecycle stage group.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the description, in the current user's language, of this object lifecycle stage.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the description, in the current user's language, of this object lifecycle state.
- getDescription() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the description, in the current user's language, of this object lifecycle state type.
- 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>."
- getDns() - Method in interface com.veeva.vault.sdk.api.core.VaultInformation
-
Retrieves the Vault DNS.
- getDocumentActionContext() - Method in interface com.veeva.vault.sdk.api.action.PostExecutionDocumentActionUIContext
-
Retrieve relevant contextual data for the document action.
- getDocumentActionContext() - Method in interface com.veeva.vault.sdk.api.action.PreExecutionDocumentActionUIContext
-
Retrieve relevant contextual data for the document action.
- getDocumentIds() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsDocumentResponse
-
Retrieves the IDs of documents which are missing one or more users provided to the original service call.
- getDocumentRole(DocumentVersion) - Method in interface com.veeva.vault.sdk.api.role.GetDocumentRolesResponse
-
- getDocumentRoles(List<DocumentVersion>, String) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- GetDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getDocumentType(DocumentTypeRequest) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
- 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
-
- 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.
- 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.
- 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
-
- getError() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationError
-
Returns the error which occurred at a particular element of a batch operation.
- getError() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Returns field rule evaluation error.
- getError() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesResponse
-
Retrieves the error encountered when retrieving the integration rules, if any.
- getError() - Method in interface com.veeva.vault.sdk.api.queue.PutMessageResponse
-
Retrieves errors about any issues encountered when putting the
Message
onto the queue.
- getErrorProvider() - Method in interface com.veeva.vault.sdk.api.queue.MessageContext
-
Retrieves the
ErrorProvider
instance associated with this Message.
- getErrors() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationResponse
-
Returns the List of errors that occurred when processing the batch.
- 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.lifecycle.UserActionExecutionOperationError
-
- getErrorType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowActionError
-
- getErrorType() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartInstanceError
-
- getEvent() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
Retrieves the
WorkflowEvent
that occurred which caused this action to fire.
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
- getEventPosition() - Method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
- getExpressionString() - Method in interface com.veeva.vault.sdk.api.data.ExpressionMetadata
-
Retrieves the given expression.
- getField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionResponse
-
Deprecated.
- getField(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionResponse
-
- getField(ObjectFieldRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- getField(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionResponse
-
- getField(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
- 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.
- getFieldRuleResults() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesResponse
-
Retrieves the result of evaluation of field rules of an integration rule.
- getFieldRules() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the list of the Fieldrules
sub-component under this Integrationrule
component.
- getFields() - 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
-
- getFields(ObjectFieldCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- getFields(DocumentFieldCollectionRequest) - Method in interface com.veeva.vault.sdk.api.document.DocumentMetadataService
-
- getFieldType() - Method in interface com.veeva.vault.sdk.api.data.ObjectField
-
Deprecated.
- getFieldType() - Method in interface com.veeva.vault.sdk.api.document.DocumentField
-
- 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
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaTextFieldMetadata
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupCurrencyFieldMetadata
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupNumberFieldMetadata
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupTextFieldMetadata
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectNumberFieldMetadata
-
- getFormatMask() - Method in interface com.veeva.vault.sdk.api.data.ObjectTextFieldMetadata
-
- getFormulaExpression() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
- 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
, or Objectlifecyclestateuseraction.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
-
- GetGroupInDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getGroupInRecordRoles(Group, List<RecordRole>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
For a given group, returns a GetGroupInRecordRolesResponse object that can be used to check if the group is in a
particular record role.
- GetGroupInRecordRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getGroups() - Method in interface com.veeva.vault.sdk.api.role.DocumentRole
-
Retrieves a list of groups which are manually assigned to this document role.
- getGroups() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
Retrieves a List of groups which are manually assigned to this
RecordRole
.
- getGroups() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a List of groups contained in this participant group.
- getGroupsAdded() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of groups added to the role.
- getGroupsbyIds(List<String>) - Method in interface com.veeva.vault.sdk.api.group.GroupService
-
- getGroupsByNames(List<String>) - Method in interface com.veeva.vault.sdk.api.group.GroupService
-
- getGroupsRemoved() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the list of groups removed from the role.
- GetGroupsResponse - Interface in com.veeva.vault.sdk.api.group
-
Provides methods to retrieve Groups.
- getHeaderNames() - Method in interface com.veeva.vault.sdk.api.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
-
- 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.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.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.
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieve the inbound relationship label of the given document reference field
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve the inbound relationship label of the given parent reference field
- getInboundRelationshipLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieve the inbound relationship label of the given reference field
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieve the inbound relationship name of the given document reference field
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve the inbound relationship name of the given parent reference field
- getInboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieve 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
-
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.BatchOperationError
-
- getInputPosition() - Method in interface com.veeva.vault.sdk.api.core.PositionalResult
-
- getIntegrationPoint() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the API name (integration_point_api_name__sys
) of the Integration Point record
referenced by this rule.
- getIntegrationPointAPIName() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequest
-
Retrieves the integration point API name.
- getIntegrationRule() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the Integration rule contract object.
- getIntegrationRules() - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesResponse
-
- getIntegrationRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
- getIntegrationRules(GetIntegrationRulesRequest) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
Retrieves the list of IntegrationRules
corresponding to a Connection based on the
GetIntegrationRulesRequest
.
- getIntegrationRulesByIntegrationPoint(String, String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleService
-
- GetIntegrationRulesRequest - Interface in com.veeva.vault.sdk.api.integration
-
- GetIntegrationRulesRequestBuilder - Interface in com.veeva.vault.sdk.api.integration
-
- GetIntegrationRulesResponse - Interface in com.veeva.vault.sdk.api.integration
-
- getItems() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the input List of job items for a given task.
- getJobId() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the ID tracking this job.
- getJobId() - Method in interface com.veeva.vault.sdk.api.job.JobRunResult
-
Retrieves the job ID.
- getJobInitParameter(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobInitParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobLogger() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the job logger, used to log messages into the job log file.
- getJobName() - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
Retrieves the name of the job.
- getJobName() - Method in interface com.veeva.vault.sdk.api.job.JobParameters
-
- getJobParameter(String, JobParamValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobParameter(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobContext
-
- getJobResult() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
Retrieves the job status, from which you can retrieve the number of tasks which failed or succeeded.
- getJsonArray() - Method in interface com.veeva.vault.sdk.api.json.JsonData
-
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, in the current user's language, of the given object field.
- getLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the label value, in the current user's language, of the given object.
- getLabel() - Method in interface com.veeva.vault.sdk.api.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.ObjectLifecycleMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle stage group.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle stage.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle state.
- getLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadata
-
Retrieves the label value, in the current user's language, of this object lifecycle state type.
- 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
-
- getLabel() - Method in interface com.veeva.vault.sdk.api.picklist.PicklistValue
-
Retrieves a picklist value's label.
- getLabel() - Method in interface com.veeva.vault.sdk.api.workflow.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.
- getLanguage() - Method in interface com.veeva.vault.sdk.api.i18n.TranslationsReadRequest
-
Retrieves the specified Vault-supported language code.
- getLanguages() - Method in interface com.veeva.vault.sdk.api.notification.TokenResolverInput
-
Retrieves a collection of language codes for the values the tokens
need to be resolved into.
- getLevel() - Method in interface com.veeva.vault.sdk.api.document.DocumentType
-
- getLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataCollectionResponse
-
- getLifecycle(ObjectLifecycleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getLifecycle(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionResponse
-
- getLifecycleLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the label value, in the current user's language, of the record's object lifecycle.
- 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.
- 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.ObjectLifecycleMetadataCollectionResponse
-
- getLifecycles(ObjectLifecycleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getLifecycles() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadataCollectionResponse
-
- 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 com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the line ending as a
String
.
- 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
-
- getLookupTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
- 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 formula number 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 formula text field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectLongTextFieldMetadata
-
Retrieves the max length value of the given object longtext field.
- getMaxLength() - Method in interface com.veeva.vault.sdk.api.data.ObjectRichTextFieldMetadata
-
Retrieves the max length value of the given object richtext 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.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.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.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
-
- 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.ObjectRecordLifecycleUserActionDetail
-
- 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 formula number 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<DocumentVersion>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.DocumentRoleService
-
- getMissingAssignments(List<Record>, String, List<String>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
- GetMissingAssignmentsDocumentResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check which users or documents are missing assignments in a particular role.
- GetMissingAssignmentsRecordResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check which users or records are missing assignments in a particular role.
- 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.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.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.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
-
- 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.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
-
- getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadataService
-
- getObjectFieldMetadataType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
- getObjectFormulaTypeMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
- 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.Record
-
Retrieves the name of the object this Record belongs to.
- 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.
- getObjectTypeName() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadata
-
Retrieves the name of object type associated with this object lifecycle stage group.
- 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.ObjectLifecycleStageMetadata
-
Retrieves the order of this object lifecycle stage.
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Return the outbound relationship name of the given document reference field
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Return the outbound relationship name of the given parent reference field
- getOutboundRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Return 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
-
- 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(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
Given a picklist
Name
, returns a
Picklist
object which can be used to retrieve
picklist information.
- getPicklist(PicklistRequest) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistService
-
- getPicklistName() - Method in interface com.veeva.vault.sdk.api.data.ObjectPicklistFieldMetadata
-
Retrieves the picklist 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.
- getPluralLabel() - Method in interface com.veeva.vault.sdk.api.data.ObjectMetadata
-
Retrieves the plural label value, in the current user's language, of the given object.
- getPrimaryQueryObject() - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves the name of the primary query object of this integration rule.
- 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
-
- 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.
- 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 the Integrationrule
- getQueryObjectRules(String) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRule
-
Retrieves any Queryobjectrules
which have the specified value for their object field.
- getQueryOperationErrorType() - Method in interface com.veeva.vault.sdk.api.query.QueryOperationError
-
Retrieves the type of error encountered during a
QueryOperation
execution.
- 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
-
- getRecordLifecycles(ObjectRecordLifecycleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- 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.
- getRecordRole(Record, String) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
Retrieves RecordRole for a given record and role.
- getRecordRole(Record) - Method in interface com.veeva.vault.sdk.api.role.GetRecordRolesResponse
-
- getRecordRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
- getRecordRoleChanges() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the changed record roles which caused the trigger to fire.
- getRecordRoleEvent() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleTriggerContext
-
Retrieves the
RecordRoleEvent
that occurred which caused this trigger to fire.
- getRecordRoles(List<Record>) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
- getRecordRoles(List<Record>, String) - Method in interface com.veeva.vault.sdk.api.role.RecordRoleService
-
- GetRecordRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
- getRecords() - Method in interface com.veeva.vault.sdk.api.action.RecordActionContext
-
Retrieve the object records this action is executing against.
- getRecords() - Method in interface com.veeva.vault.sdk.api.data.ReadRecordsResponse
-
Returns a Map of retrieved Records where
key
is the Record
id
and
value
is
Record
.
- getRecords() - Method in interface com.veeva.vault.sdk.api.role.GetMissingAssignmentsRecordResponse
-
Retrieves the records which are missing one or more users provided to the original service call.
- getRecords() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
- getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieve the referenced object name of the given document reference field
- getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve the referenced object name of the given parent reference field
- getReferencedObjectName() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieve the referenced object name of the given reference field
- 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
-
- getRelatedCorporateCurrencyField() - Method in interface com.veeva.vault.sdk.api.data.ObjectCurrencyFieldMetadata
-
Retrieves the related corporate currency field name of 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 of the given
currency field.
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
Retrieve the relationship criteria of the given document reference field
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
Retrieve the relationship criteria of the given parent reference field
- getRelationshipCriteria() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
Retrieve the relationship criteria of the given reference field
- getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
- getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectParentReferenceFieldMetadata
-
- getRelationshipDeleteType() - Method in interface com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadata
-
- getRelationshipName() - Method in interface com.veeva.vault.sdk.api.data.ObjectLookupFieldMetadata
-
Retrieves the relationship name to the source object of the given lookup field.
- 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.
- 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.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.
- getRetryAttempt() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the task retry number.
- getRole(ObjectLifecycleRoleMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getRole() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadata
-
Retrieves the application role associated with this object lifecycle role.
- getRole(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionResponse
-
- getRole() - Method in interface com.veeva.vault.sdk.api.role.LifecycleRole
-
Retrieves the application role associated with the lifecycle role.
- getRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRole
-
- getRole() - Method in interface com.veeva.vault.sdk.api.role.RecordRoleChange
-
Retrieves the
Role
in the record role change.
- getRoleId() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role ID.
- getRoleLabel() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role label, for example, Approver.
- getRoleName() - Method in interface com.veeva.vault.sdk.api.role.Role
-
Retrieves the application role name, for example, approver__c
.
- 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(ObjectLifecycleRoleMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getRoles() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataCollectionResponse
-
- getRoles() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroup
-
Retrieves a list of application roles contained in this participant group
- 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 formula number 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.
- 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
-
Retreives 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
-
- getStage(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionResponse
-
- getStageGroup(ObjectLifecycleStageGroupMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStageGroup(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionResponse
-
- 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(ObjectLifecycleStageGroupMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStageGroups() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageGroupMetadataCollectionResponse
-
- 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.ObjectLifecycleStageGroupMetadata
-
Retrieves the names of the stages in this object lifecycle stage group.
- getStages(ObjectLifecycleStageMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStages() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataCollectionResponse
-
- getStartStepMetadataList() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowStartMetadataResponse
-
- 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
-
- getState(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionResponse
-
- getStateLabel() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleMetadata
-
Retrieves the label value, in the current user's language, of the record's object lifecycle state.
- 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.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(ObjectLifecycleStateMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStates() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateMetadataCollectionResponse
-
- getStateType(ObjectLifecycleStateTypeMetadataRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStateType(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionResponse
-
- 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(ObjectLifecycleStateTypeMetadataCollectionRequest) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleMetadataService
-
- getStateTypes() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStateTypeMetadataCollectionResponse
-
- getStatus() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskInstance
-
Retrieves the status of the current task instance.
- getStepType() - Method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
- 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.
- getTargetDocfield() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the reference to a document field, if target is a document.
- getTargetField() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Retrieves the target field name corresponding to this field rule evaluation.
- getTargetName() - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequest
-
Retrieves the name of the target object from the Fieldrule
sub-component.
- getTargetObject() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the target Vault object.
- getTargetObjectField() - Method in interface com.veeva.vault.sdk.api.integration.FieldRule
-
Retrieves the name of the target object field.
- getTaskChanges() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionTaskContext
-
Retrieves the changes for workflow task instances with the current task event, if the event is for
WorkflowStepType.TASK
.
- getTaskConfiguration() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionTaskContext
-
- getTaskContext() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
- getTaskId() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the task ID, such as "TASK1" or "TASK2".
- getTaskInstances(WorkflowInstance, WorkflowTaskQueryParameters) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowTaskService
-
Retrieves task instances for a workflow instance.
- getTaskOutput() - Method in interface com.veeva.vault.sdk.api.job.JobTask
-
Retrieves the TaskOutput object which can be used to get or set the output parameters for a given task.
- getTasks() - Method in interface com.veeva.vault.sdk.api.job.JobCompletionContext
-
- 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.core.ErrorResult
-
Returns a machine-readable error type
An error message of this form can be used to make programmatic decisions.
If the error is raised by Vault Java SDK Code, for example by calling
RecordChange.setError(String, String)
,
type
will always be
SDK_ERROR
.
The
subtype
value specified by Vault Java SDK Code can be retrieved using
ErrorResult.getSubtype()
- getType() - Method in interface com.veeva.vault.sdk.api.data.ObjectFormulaFieldMetadata
-
- 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.lifecycle.ObjectLifecycleUserActionMetadata
-
Retrieves the type of this object lifecycle user action.
- 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.
- getTypedObjectFieldMetadata(Class<T>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata
-
Retrieves a subclass of
ObjectFieldMetadata
so the type field attributes of the given object field
can be fetched.
- getTypedWorkflowItem(Class<T>) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItem
-
- 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.document.DocumentType
-
Retrieves the document type name of the given document type.
- getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleUserActionCollectionResponse
-
- getUserAction(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionCollectionResponse
-
- 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.ObjectLifecycleUserActionCollectionResponse
-
- getUserActions() - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectRecordLifecycleUserActionCollectionResponse
-
- 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
-
- GetUserInDocumentRolesResponse - Interface in com.veeva.vault.sdk.api.role
-
Provides methods to check if a particular user is assigned to a given document role.
- 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 the user_input_object
.
- 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 the user_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
-
- 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(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.action.ConfigurationContext
-
Retrieves a parameter's value.
- getValue(String, RequestContextValueType<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the value identified by the given name
from the request context.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.core.RequestContext
-
Retrieves the value identified by the given name
from the request context.
- getValue(int, CsvValueType<T>) - Method in interface com.veeva.vault.sdk.api.csv.Row
-
Retrieves a value at a column specified by its index.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.data.Record
-
Retrieves the value of the specified Record field.
- getValue(String, ValueType<T>) - Method in interface com.veeva.vault.sdk.api.document.DocumentVersion
-
Retrieves the value of the specified document field.
- getValue() - Method in interface com.veeva.vault.sdk.api.integration.FieldRuleResult
-
Retrieves the value for the evaluated target field, already converted into the appropriate ValueType.
- getValue(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.JobItem
-
Retrieves the value of a job item parameter.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.JobItem
-
Retrieves the value of a job item parameter.
- getValue(String, JobValueType<T>) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the value identified by the given name
from the task output.
- getValue(String, Class<T>) - Method in interface com.veeva.vault.sdk.api.job.TaskOutput
-
Retrieves the value identified by the given name
from the task output.
- getValue(int, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonArray
-
Retrieves a value contained at the given index.
- getValue(String, JsonValueType<T>) - Method in interface com.veeva.vault.sdk.api.json.JsonObject
-
Retrieves the value of a property with the given name.
- 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.
- 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.
- getValueClass() - Method in class com.veeva.vault.sdk.api.workflow.WorkflowInputValueTypeImpl
-
Get Java class for this data type.
- 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.document.DocumentField
-
Retrieves the
ValueType
of the given document field.
- getVersionType() - Method in interface com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadata
-
- getWorkflow(String) - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionResponse
-
- getWorkflowConfiguration() - Method in interface com.veeva.vault.sdk.api.workflow.RecordWorkflowActionContext
-
- 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(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionResponse
-
- getWorkflowInstance(WorkflowInstanceRequest) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
- getWorkflowInstances() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceCollectionResponse
-
- 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(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.
- getWorkflowItems() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowItemsResponse
-
Retrieves the items in the requested workflow.
- 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.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(String) - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowInstanceService
-
- getWorkflowParticipantGroups() - Method in interface com.veeva.vault.sdk.api.workflow.WorkflowParticipantGroupResponse
-
Retrieves the workflow participant groups in the active requested workflow.
- getWorkflows() - Method in interface com.veeva.vault.sdk.api.workflow.AvailableWorkflowMetadataCollectionResponse
-
- 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.
- GroupService - Interface in com.veeva.vault.sdk.api.group
-
- GroupType - Enum in com.veeva.vault.sdk.api.group
-
Valid values for group classifications.
- 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 com.veeva.vault.sdk.api.action.Usage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.connection.ConnectionUser
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.EventPosition
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.EventSegment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.RequestContextUserType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.csv.LineEnding
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectFieldType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.data.SourceType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.document.DocumentFieldType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.email.EmailBodyType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.email.EmailSenderType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.group.GroupType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.http.HttpMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.ItemErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.MessageErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.job.TaskState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.notification.NotificationMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.query.QueryTargetOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.veeva.vault.sdk.api.action.Usage
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.connection.ConnectionUser
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.EventPosition
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.EventSegment
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.RequestContextUserType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.TriggerOrder
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.UserDefinedPropertyInclude
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.core.VaultInformationOperationError.VaultInformationOperationErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.csv.LineEnding
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectDocumentReferenceFieldMetadataVersionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectFieldMetadataType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectFieldType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectFormulaCurrencyFieldMetadataReturnType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectFormulaFieldType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectLookupFieldType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectMetadataDataStore
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.ObjectReferenceFieldMetadataDeleteType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.RecordEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.data.SourceType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.document.DocumentFieldType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.document.DocumentTypeLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.email.EmailBodyType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.email.EmailSenderType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.group.GroupType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.http.HttpMethod
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.http.HttpOperationErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.http.HttpRequestContentType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.integration.ItemErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.integration.MessageErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.integration.ReferenceLookupType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.job.TaskState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.lifecycle.ActionErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.notification.NotificationMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.query.QueryEscapeOverride
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.query.QueryLogicalOperator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.query.QueryOperationErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.query.QueryTargetOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.queue.MessageDeliveryErrorType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.role.RecordRoleEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowItemType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowStartStepType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowStepType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowTaskStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.veeva.vault.sdk.api.workflow.WorkflowType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- ValueType<T> - Interface in com.veeva.vault.sdk.api.core
-
Type of data supported by the Vault Java SDK.
- VaultCollections - Class in com.veeva.vault.sdk.api.core
-
A utility to create JDK Collections and Arrays.
- VaultCollections() - Constructor for class com.veeva.vault.sdk.api.core.VaultCollections
-
- VaultCollectors - Class in com.veeva.vault.sdk.api.core
-
- VaultCollectors() - Constructor for class com.veeva.vault.sdk.api.core.VaultCollectors
-
- 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
-
- VaultInformationOperationError - Interface in com.veeva.vault.sdk.api.core
-
Consumed by VaultInformationOperation objects
- VaultInformationOperationError.VaultInformationOperationErrorType - Enum in com.veeva.vault.sdk.api.core
-
- VaultInformationService - Interface in com.veeva.vault.sdk.api.core
-
- VaultRuntimeException - Exception in com.veeva.vault.sdk.api.core
-
- VaultRuntimeException() - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with null
as its
detail message.
- VaultRuntimeException(String) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with the specified detail message.
- VaultRuntimeException(String, Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with the specified detail message and
cause.
- VaultRuntimeException(Throwable) - Constructor for exception com.veeva.vault.sdk.api.core.VaultRuntimeException
-
Deprecated.
Constructs a new runtime exception with the specified cause and a
detail message of (cause==null ? null : cause.toString())
,
which typically contains the class and detail message of
cause
.
- 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.
- 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 object lifecycles requested.
- 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.
- withAllQueryObjectRules(boolean) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
- 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.
- 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.
- withConnectionId(String) - Method in interface com.veeva.vault.sdk.api.integration.GetIntegrationRulesRequestBuilder
-
Required: Sets the connection ID.
- withDialog(UserActionExecutionDialog) - Method in interface com.veeva.vault.sdk.api.action.PreExecutionUserActionUIBehavior.Builder
-
Display an execution confirmation dialog at runtime.
- 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
-
- withDocumentTypeDetailId(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document type detail record id.
- 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.
- 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.
- withFieldNames(List<String>) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldMetadataCollectionRequest.Builder
-
Optional: Sets a filter to retrieve field metadata of the specified names.
- withFieldNames(Set<String>) - Method in interface com.veeva.vault.sdk.api.document.DocumentFieldCollectionRequest.Builder
-
Optional: Sets the field names.
- 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.WorkflowParticipantInputParameter.Builder
-
Optional: sets a list of group IDs for this participant input.
- 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.
- 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
-
- 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.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.
- 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.
- 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.
- withName(String) - Method in interface com.veeva.vault.sdk.api.picklist.PicklistRequest.Builder
-
Given a picklist name
, builds a request for this picklist.
- withObjectName(String) - Method in interface com.veeva.vault.sdk.api.data.ObjectFieldCollectionRequest.Builder
-
- 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.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 object lifecycles requested.
- 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
- 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.lifecycle.ObjectLifecycleStageGroupMetadataCollectionRequest.Builder
-
Optional: sets the names of the object types associated with the object lifecycle stage groups requested.
- withOrderBy(List<String>) - Method in interface com.veeva.vault.sdk.api.query.Query.Builder
-
Sets the ORDER BY
clause, replacing previously set values.
- 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.
- withQueryObjectRules(List<String>) - Method in interface com.veeva.vault.sdk.api.integration.IntegrationRuleQuery.Builder
-
- 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
.
- 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.
- 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(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.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.
- 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.
- withRoleName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleRoleMetadataRequest.Builder
-
Required: sets the object lifecycle role name.
- 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.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.
- withStageName(String) - Method in interface com.veeva.vault.sdk.api.lifecycle.ObjectLifecycleStageMetadataRequest.Builder
-
Required: sets the name of requested object lifecycle stage.
- 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.
- 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.
- withTargetName(String) - Method in interface com.veeva.vault.sdk.api.integration.EvaluateFieldRulesRequestBuilder
-
Required: Sets the target name.
- withTitle(String) - Method in interface com.veeva.vault.sdk.api.action.UserActionExecutionDialog.Builder
-
Optional: Set the title for this dialog.
- withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryCountRequest.Builder
-
- withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryExecutionRequest.Builder
-
- withTokenRequest(TokenRequest, QueryEscapeOverride...) - Method in interface com.veeva.vault.sdk.api.query.QueryValidationRequest.Builder
-
- withType(String) - Method in interface com.veeva.vault.sdk.api.document.DocumentTypeRequest.Builder
-
Optional: Sets the document type name.
- 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
-
- 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.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.WorkflowParticipantInputParameter.Builder
-
Optional: sets a list of user IDs for this participant input.
- 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(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.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.
- 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.
- WorkflowActionError - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowActionResponse - Interface in com.veeva.vault.sdk.api.workflow
-
Contains methods to retrieve information about the workflow action.
- WorkflowCancelOperation - Interface in com.veeva.vault.sdk.api.workflow
-
- 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
-
- WorkflowConfiguration - Interface in com.veeva.vault.sdk.api.workflow
-
Represents the configured workflow definition.
- WorkflowEvent - Enum in com.veeva.vault.sdk.api.workflow
-
Events surrounding workflow execution.
- WorkflowInputValueType<T> - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowInputValueTypeImpl<T> - Class in com.veeva.vault.sdk.api.workflow
-
- WorkflowInputValueTypeImpl(Class<T>) - Constructor for class com.veeva.vault.sdk.api.workflow.WorkflowInputValueTypeImpl
-
- 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
-
Request to retrieve a list of
WorkflowInstance
for the given
list of document or record or workflow ids.
- WorkflowInstanceCollectionRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowInstanceCollectionResponse - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowInstanceRequest - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowInstanceRequest.Builder - Interface in com.veeva.vault.sdk.api.workflow
-
- 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
-
- WorkflowItemType - Enum 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.
- WorkflowParticipantGroupResponse - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowParticipantGroupUpdate - Interface in com.veeva.vault.sdk.api.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
-
- 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
-
- WorkflowStartInstanceOperation<T> - Interface in com.veeva.vault.sdk.api.workflow
-
- 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
-
- 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
-
- WorkflowStartMetadataResponse - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowStartStepMetadata - Interface in com.veeva.vault.sdk.api.workflow
-
- WorkflowStartStepType - Enum in com.veeva.vault.sdk.api.workflow
-
Start step types.
- WorkflowStepType - Enum 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 bring 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 in com.veeva.vault.sdk.api.workflow
-
Statuses a workflow task instance can be in.
- WorkflowType - Enum in com.veeva.vault.sdk.api.workflow
-
Types of workflows supported