com.veeva.vault.vapil.api.model.response

Class VaultResponse

java.lang.Object

com.veeva.vault.vapil.api.model.VaultModel

com.veeva.vault.vapil.api.model.response.VaultResponse

Direct Known Subclasses:

ApiVersionResponse, AuditDetailsResponse, AuditMetadataResponse, AuditTypesResponse, AuthenticationResponse, BinderExportResponse, BinderResponse, BinderSectionResponse, BinderTemplateBulkResponse, BinderTemplateBulkResponse.TemplateResult, BinderTemplateMetadataResponse, BinderTemplateNodeBulkResponse, BinderTemplateNodeBulkResponse.TemplateNodeResult, BinderTemplateResponse, BulkWorkflowActionDetailsResponse, BulkWorkflowActionsResponse, BulkWorkflowJobStartResponse, ComponentContentResponse, DiscoveryResponse, DocumentActionEntryCriteriaResponse, DocumentActionInitiateResponse, DocumentActionResponse, DocumentAnnotationResponse, DocumentAttachmentBulkResponse, DocumentAttachmentResponse, DocumentBulkResponse, DocumentClassificationResponse, DocumentDeletionResponse, DocumentEventResponse, DocumentEventSubtypeResponse, DocumentEventTypeResponse, DocumentExportResponse, DocumentExportResponse.ExportedDocument, DocumentFieldResponse, DocumentLifecycleDeleteOverrideRulesResponse, DocumentLifecycleRoleAssignmentResponse, DocumentLifecycleRoleAssignmentRulesResponse, DocumentLockResponse, DocumentRelationshipBulkResponse, DocumentRelationshipMetadataResponse, DocumentRelationshipResponse, DocumentRelationshipRetrieveResponse, DocumentRenditionResponse, DocumentResponse, DocumentRoleChangeBulkResponse, DocumentRoleChangeBulkResponse.DocumentRoleChange, DocumentRoleChangeResponse, DocumentRoleCheckForDCCResponse, DocumentRoleRetrieveResponse, DocumentsResponse, DocumentTemplateBulkResponse, DocumentTemplateBulkResponse.TemplateResult, DocumentTemplateMetadataResponse, DocumentTemplateResponse, DocumentTemplatesResponse, DocumentTokenResponse, DocumentTypesResponse, DocumentVersionResponse, DocumentWorkflowMetadataResponse, DomainResponse, EDLResponse, FileStagingItemBulkResponse, FileStagingItemResponse, FileStagingJobResponse, FileStagingSessionBulkResponse, FileStagingSessionResponse, GroupResponse, GroupRetrieveResponse, InitiateMultiDocumentWorkflowResponse, JobCreateResponse, JobHistoryResponse, JobMonitorResponse, JobStatusResponse, JobTaskResponse, LoaderResponse, MdlResponse, MetaDataComponentRecordResponse, MetaDataComponentTypeBulkResponse, MetaDataComponentTypeResponse, MetaDataDocumentLockResponse, MetaDataGroupResponse, MetaDataObjectBulkResponse, MetaDataObjectFieldResponse, MetaDataObjectResponse, MetaDataUserResponse, MultiDocumentWorkflowDetailsResponse, MultiDocumentWorkflowsResponse, ObjectRecordActionBulkResponse, ObjectRecordActionResponse, ObjectRecordAttachmentResponse, ObjectRecordBulkResponse, ObjectRecordCollectionResponse, ObjectRecordDeletedResponse, ObjectRecordResponse, ObjectRecordRoleChangeResponse, ObjectRecordRoleResponse, ObjectRecordTypeResponse, ObjectWorkflowActionDetailsResponse, ObjectWorkflowActionResponse, ObjectWorkflowResponse, ObjectWorkflowTaskActionDetailsResponse, ObjectWorkflowTaskResponse, PackageResponse, PackageResultsResponse, PicklistResponse, PicklistValueResponse, QueryResponse, QueueResponse, SandboxEntitlementResponse, SandboxResponse, SCIMResponse, SCIMUserBulkResponse, SCIMUserResponse, SDKResponse, SecurityPoliciesResponse, SecurityPolicyResponse, UserBulkResponse, UserPermissionResponse, UserResponse, UserRetrieveResponse, ValidatePackageResponse

public class VaultResponse
extends VaultModel

Base Vault API response message

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultResponse.APIResponseError

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_CONTENT_DISPOSITION Content-Disposition
static String	HTTP_HEADER_CONTENT_TYPE Content-Type
static String	HTTP_HEADER_VAULT_BURST X-VaultAPI-BurstLimit
static String	HTTP_HEADER_VAULT_BURST_REMAINING X-VaultAPI-BurstLimitRemaining
static String	HTTP_HEADER_VAULT_EXECUTION_ID X-VaultAPI-ExecutionId
static String	HTTP_HEADER_VAULT_ID X-VaultAPI-VaultId
static String	HTTP_HEADER_VAULT_RESPONSE_DELAY X-VaultAPI-ResponseDelay
static String	HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID X-VaultAPI-TruncatedSessionId
static String	HTTP_HEADER_VAULT_USER_ID X-VaultAPI-UserId
static String	HTTP_RESPONSE_FAILURE responseStatus = FAILURE
static String	HTTP_RESPONSE_SUCCESS responseStatus = SUCCESS

Constructor Summary

Constructors

Constructor and Description
VaultResponse()

Method Summary

Modifier and Type	Method and Description
byte[]	getBinaryContent() For requests returning binary content
List<VaultResponse.APIResponseError>	getErrors()
String	getHeaderContentType()
Map<String,List<String>>	getHeaders()
Integer	getHeaderVaultBurstLimit()
Integer	getHeaderVaultBurstLimitRemaining()
String	getHeaderVaultExecutionId()
Integer	getHeaderVaultId()
String	getHeaderVaultResponseDelay()
String	getHeaderVaultTruncatedSessionId()
String	getHeaderVaultUserId()
String	getHttpHeaderContentDisposition()
String	getOutputFilePath() Return the file path For requests creating files
String	getResponse() Get the full response as a string
org.json.JSONObject	getResponseJSON() Get the full response as a JSON Object
String	getResponseMessage()
String	getResponseStatus()
boolean	hasErrors() Determine if errors exist in the API Response
boolean	isSuccessful()
void	setBinaryContent(byte[] binaryContent)
void	setErrors(List<VaultResponse.APIResponseError> errors)
void	setHeaders(Map<String,List<String>> headers)
void	setOutputFilePath(String outputFilePath)
void	setResponse(String response)
void	setResponseMessage(String responseMessage)
void	setResponseStatus(String responseStatus)

Methods inherited from class com.veeva.vault.vapil.api.model.VaultModel

get, getBoolean, getFieldNames, getInteger, getListInteger, getListLong, getListString, getLong, getString, getVaultModelData, set, setVaultModelData, toJSONObject, toJsonString, toMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_RESPONSE_FAILURE

public static final String HTTP_RESPONSE_FAILURE

responseStatus = FAILURE

See Also:

Constant Field Values

HTTP_RESPONSE_SUCCESS

public static final String HTTP_RESPONSE_SUCCESS

responseStatus = SUCCESS

See Also:

Constant Field Values

HTTP_HEADER_CONTENT_DISPOSITION

public static final String HTTP_HEADER_CONTENT_DISPOSITION

Content-Disposition

See Also:

Constant Field Values

HTTP_HEADER_CONTENT_TYPE

public static final String HTTP_HEADER_CONTENT_TYPE

Content-Type

See Also:

Constant Field Values

HTTP_HEADER_VAULT_BURST

public static final String HTTP_HEADER_VAULT_BURST

X-VaultAPI-BurstLimit

See Also:

Constant Field Values

HTTP_HEADER_VAULT_BURST_REMAINING

public static final String HTTP_HEADER_VAULT_BURST_REMAINING

X-VaultAPI-BurstLimitRemaining

See Also:

Constant Field Values

HTTP_HEADER_VAULT_EXECUTION_ID

public static final String HTTP_HEADER_VAULT_EXECUTION_ID

X-VaultAPI-ExecutionId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_RESPONSE_DELAY

public static final String HTTP_HEADER_VAULT_RESPONSE_DELAY

X-VaultAPI-ResponseDelay

See Also:

Constant Field Values

HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID

public static final String HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID

X-VaultAPI-TruncatedSessionId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_USER_ID

public static final String HTTP_HEADER_VAULT_USER_ID

X-VaultAPI-UserId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_ID

public static final String HTTP_HEADER_VAULT_ID

X-VaultAPI-VaultId

See Also:

Constant Field Values

Constructor Detail

VaultResponse

public VaultResponse()

Method Detail

isSuccessful

public boolean isSuccessful()

Returns:

true if there was a successful response

getResponseMessage

public String getResponseMessage()

setResponseMessage

public void setResponseMessage(String responseMessage)

getResponseStatus

public String getResponseStatus()

setResponseStatus

public void setResponseStatus(String responseStatus)

getResponse

public String getResponse()

Get the full response as a string

Returns:

The full response as a string

setResponse

public void setResponse(String response)

getResponseJSON

public org.json.JSONObject getResponseJSON()

Get the full response as a JSON Object

Returns:

The full response as a JSON Object

getErrors

public List<VaultResponse.APIResponseError> getErrors()

setErrors

public void setErrors(List<VaultResponse.APIResponseError> errors)

hasErrors

public boolean hasErrors()

Determine if errors exist in the API Response

Returns:

True if errors exist

getHeaders

public Map<String,List<String>> getHeaders()

setHeaders

public void setHeaders(Map<String,List<String>> headers)

getHttpHeaderContentDisposition

public String getHttpHeaderContentDisposition()

getHeaderContentType

public String getHeaderContentType()

getHeaderVaultBurstLimit

public Integer getHeaderVaultBurstLimit()

getHeaderVaultBurstLimitRemaining

public Integer getHeaderVaultBurstLimitRemaining()

getHeaderVaultExecutionId

public String getHeaderVaultExecutionId()

getHeaderVaultId

public Integer getHeaderVaultId()

getHeaderVaultResponseDelay

public String getHeaderVaultResponseDelay()

getHeaderVaultTruncatedSessionId

public String getHeaderVaultTruncatedSessionId()

getHeaderVaultUserId

public String getHeaderVaultUserId()

getBinaryContent

public byte[] getBinaryContent()

For requests returning binary content

Returns:

Byte array for the returned binary content

setBinaryContent

public void setBinaryContent(byte[] binaryContent)

getOutputFilePath

public String getOutputFilePath()

Return the file path For requests creating files

Returns:

The file path of the created file

setOutputFilePath

public void setOutputFilePath(String outputFilePath)