Package com.veeva.vault.vapil.api.model

Class VaultModel

java.lang.Object
com.veeva.vault.vapil.api.model.VaultModel
Direct Known Subclasses:
ActionResponse.LifecycleAction, ApiVersionResponse.ApiVersion, AuditDetailsResponse.Audit, AuditDetailsResponse.ResponseDetails, AuditDetailsResponse.ResponseDetails.DetailsObject, AuditMetadataResponse.AuditMetadata, AuditMetadataResponse.AuditMetadata.Field, AuditTypesResponse.AuditTrail, AuthenticationResponse.Vault, Binder, Binder.Node, Binder.Node.BinderSection, BinderResponse.Version, BinderTemplate, BulkTranslationImportSummaryResponse.Data, BulkTranslationJobResponse.Data, BulkWorkflowActionDetailsResponse.BulkWorkflowActionDetails, BulkWorkflowActionDetailsResponse.Control, BulkWorkflowActionDetailsResponse.Prompt, BulkWorkflowActionsResponse.ActionItem, BulkWorkflowJobStartResponse.Job, ClientCodeDistribution, ComponentContentResponse.ComponentContent, ComponentContentResponse.Link, ComponentQueryResponse.QueryResult, ComponentQueryResponse.ResponseDetails, ComponentRecord, ComponentType, ComponentType.Attribute, ComponentType.SubComponentType, CustomPagesDistributionResponse.ClientCodeDistributionUpdate, DelegationsResponse.DelegatedVault, DirectDataResponse.DirectDataItem, DirectDataResponse.DirectDataItem.FilePart, DirectDataResponse.ResponseDetails, DiscoveryResponse.DiscoveryData, DiscoveryResponse.DiscoveryData.AuthProfile, DiscoveryResponse.DiscoveryData.AuthProfile.AsMetadata, Document, DocumentAnnotation, DocumentAnnotation.Placemark, DocumentAnnotation.ResponseDetails, DocumentAnnotationAnchorResponse.AnchorData, DocumentAnnotationDeleteResponse.DeletedAnnotation, DocumentAnnotationDeleteResponse.DeletedAnnotation.Error, DocumentAnnotationPlacemarkTypeMetadataResponse.PlacemarkTypeMetadata, DocumentAnnotationPlacemarkTypeMetadataResponse.PlacemarkTypeMetadata.PlacemarkField, DocumentAnnotationReferenceTypeMetadataResponse.ReferenceTypeMetadata, DocumentAnnotationReferenceTypeMetadataResponse.ReferenceTypeMetadata.ReferenceField, DocumentAnnotationReply, DocumentAnnotationReply.Placemark, DocumentAnnotationReply.ResponseDetails, DocumentAnnotationResponse, DocumentAnnotationResponse.Error, DocumentAnnotationTypeMetadataResponse.AnnotationTypeMetadata, DocumentAnnotationTypeMetadataResponse.AnnotationTypeMetadata.AnnotationField, DocumentAttachment, DocumentAttachment.Version, DocumentClassificationResponse.AvailableLifecycle, DocumentClassificationResponse.RelationshipType, DocumentClassificationResponse.Template, DocumentDeletionResponse.DeleteDocument, DocumentDeletionResponse.ResponseDetails, DocumentEvent, DocumentEvent.Property, DocumentEventSubtypeResponse.DocumentEventSubtype, DocumentEventSubtypeResponse.DocumentEventSubtype.Value, DocumentEventTypeResponse.Event, DocumentEventTypeResponse.Event.SubType, DocumentField, DocumentField.UsedIn, DocumentLifecycleDeleteOverrideRulesResponse.DeleteOverrideRule, DocumentLifecycleRoleAssignmentResponse.RoleAssignment, DocumentLock, DocumentLockResponse.Lock, DocumentRelationship, DocumentRelationshipMetadataResponse.Relationship, DocumentRelationshipMetadataResponse.Relationship.RelationshipObject, DocumentRelationshipMetadataResponse.RelationshipProperty, DocumentRelationshipMetadataResponse.RelationshipType, DocumentRelationshipMetadataResponse.RelationshipType.TargetDocumentType, DocumentRelationshipRetrieveResponse.Relationship, DocumentRenditionBulkResponse.Rendition, DocumentRenditionResponse.Renditions, DocumentResponse.Version, DocumentRetrieveAttachment, DocumentRoleCheckForDCCResponse.DocumentRoleCheckForDCC, DocumentSignatureMetadataResponse.Properties, DocumentSignatureMetadataResponse.Properties.Field, DocumentsResponse.DocumentNode, DocumentSubtypeResponse.DocumentClassification, DocumentTemplate, DocumentTokenResponse.Token, DocumentTypeResponse.DocumentSubtype, DocumentTypesResponse.DocumentType, DocumentVersionResponse.Version, DocumentWorkflowDetailsResponse.Control, DocumentWorkflowDetailsResponse.DocumentWorkflow, DocumentWorkflowDetailsResponse.Prompt, DocumentWorkflowResponse.DocumentWorkflow, DomainAuditResponse.DomainAuditData, DomainResponse.Domain, DomainResponse.Domain.DomainVault, DomainResponse.Domain.DomainVault.VaultApplication, DomainResponse.Domain.DomainVault.VaultFamily, DomainsResponse.Domain, EDLMatchedDocumentResponse.EdlMatchedDocument, EDLResponse.EDLNode, EmailNotificationHistoryResponse.EmailNotification, EmailNotificationHistoryResponse.ResponseDetails, EntryCriteriaResponse.Property, EntryCriteriaResponse.Property.ObjectTypeReferenced, FileStagingItemBulkResponse.FileStagingItem, FileStagingItemBulkResponse.ResponseDetails, FileStagingItemResponse.FileStagingItem, FileStagingJobResponse.Job, FileStagingSessionBulkResponse.ResponseDetails, Group, Group, Group.ImpliedMember, GroupRetrieveAutoManagedResponse.Data, GroupRetrieveResponse.GroupNode, InitiateDocumentWorkflowResponse.DocumentWorkflowData, Job, Job.Link, JobHistoryResponse.ResponseDetails, JobMonitorResponse.ResponseDetails, JobTaskResponse.JobTask, JobTaskResponse.ResponseDetails, LoaderTask, MdlExecuteResponse.ScriptExecution, MdlExecuteResponse.StatementExecution, OauthTokenResponse, ObjectAttachment, ObjectAttachment.Version, ObjectMultiRecordWorkflowDetailsResponse.Control, ObjectMultiRecordWorkflowDetailsResponse.Control.Prompt, ObjectMultiRecordWorkflowDetailsResponse.MultiRecordWorkflow, ObjectMultiRecordWorkflowInitiateResponse.MultiRecordWorkflowData, ObjectMultiRecordWorkflowsResponse.MultiRecordWorkflow, ObjectRecord, ObjectRecordActionResponse.Action, ObjectRecordActionResponse.Link, ObjectRecordCollectionResponse.ResponseDetails, ObjectRecordDeletedResponse.DeletedRecord, ObjectRecordDeletedResponse.ResponseDetails, ObjectRecordMergeJobResponse.Job, ObjectRecordMergeResultsResponse.Data, ObjectRecordMergeResultsResponse.Data.MergeSet, ObjectRecordMergeResultsResponse.Data.MergeSet.Error, ObjectRecordResponse.ResponseDetails, ObjectRecordRoleChangeResponse.ObjectRoleChange, ObjectRecordRoleChangeResponse.ObjectRoleChange.ObjectRole, ObjectRecordRoleResponse.ObjectRole, ObjectRecordType, ObjectRecordType.LocalizedData, ObjectRecordType.LocalizedData.Label, ObjectRecordType.LocalizedData.LabelPlural, ObjectRecordType.ObjectRecordTypeAction, ObjectRecordType.ObjectRecordTypeField, ObjectWorkflowActionDetailsResponse.Control, ObjectWorkflowActionDetailsResponse.CurrentValue, ObjectWorkflowActionDetailsResponse.Prompt, ObjectWorkflowActionDetailsResponse.WorkflowAction, ObjectWorkflowActionResponse.WorkflowAction, ObjectWorkflowResponse.ObjectWorkflow, ObjectWorkflowResponse.ResponseDetails, ObjectWorkflowTaskActionDetailsResponse.Control, ObjectWorkflowTaskActionDetailsResponse.Control.Prompt, ObjectWorkflowTaskActionDetailsResponse.Control.Reason, ObjectWorkflowTaskActionDetailsResponse.Control.Verdict, ObjectWorkflowTaskActionDetailsResponse.ObjectWorkflowTaskAction, ObjectWorkflowTaskResponse.ObjectWorkflowTask, ObjectWorkflowTaskResponse.ResponseDetails, OutboundPackageDependenciesResponse.PackageDependency, OutboundPackageDependenciesResponse.ResponseDetails, PackageDeploymentResultsResponse.ResponseDetails, PackageImportResultsResponse.VaultImportPackage, PackageLog, PackageModel, PackageStep.Dependency, PicklistResponse.Picklist, PicklistResponse.Picklist.UsedIn, PicklistValueResponse.PicklistValue, QueryResponse.QueryDescribe, QueryResponse.QueryDescribe.QueryObject, QueryResponse.QueryResult, QueryResponse.RecordProperty, QueryResponse.RecordProperty.FieldAdditionalData, QueryResponse.ResponseDetails, QueueResponse.Queue, QueueResponse.Queue.Connection, QueueResponse.Queue.Connection.QueueError, Renditions, ResumableUploadSession, ResumableUploadSessionPart, RoleRetrieveResponse.Role, SandboxDetailsResponse.Entitlement, SandboxDetailsResponse.Limits, SandboxDetailsResponse.Sandbox, SandboxEntitlementResponse.SandboxEntitlement, SandboxEntitlementResponse.SandboxEntitlement.Entitlement, SandboxResponse.Entitlement, SandboxResponse.Sandbox, SandboxResponse.SourceVault, SandboxSnapshotResponse.Sandbox, SandboxSnapshotResponse.Snapshot, SCIMAttribute, SCIMResponse.AuthenticationScheme, SCIMResponse.Bulk, SCIMResponse.ChangePassword, SCIMResponse.Etag, SCIMResponse.Filter, SCIMResponse.Meta, SCIMResponse.Patch, SCIMResponse.Resource, SCIMResponse.Resource.Schema, SCIMResponse.Sort, SCIMUser, SCIMUser.Email, SCIMUser.Meta, SCIMUser.Name, SCIMUser.Schema, SCIMUser.SchemaUserObject, SCIMUser.SchemaUserObject.ReferenceValue, SdkDebugSession, SdkDebugSession.ClassFilter, SdkProfilingSession, SecurityPoliciesResponse.SecurityPolicy, SecurityPolicy, SecurityPolicy.Object, SecurityPolicy.Object.Property, SecurityPolicy.Property, SecurityPolicy.Property.ObjectTypeReference, SecurityPolicyResponse.SecurityPolicy, SecurityPolicyResponse.SecurityPolicy.PolicyDetails, SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings, SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings.AuthenticationType, Template, User, User, User.Values, UserLicenseUsageResponse.Application, UserLicenseUsageResponse.Application.UserLicensing, UserLicenseUsageResponse.Application.UserLicensing.ExternalLicense, UserLicenseUsageResponse.Application.UserLicensing.FullLicense, UserLicenseUsageResponse.Application.UserLicensing.ReadOnlyLicense, UserLicenseUsageResponse.DocCount, UserPermissionResponse.UserPermissions, UserPermissionResponse.UserPermissions.PermissionSet, UserRetrieveResponse.UserNode, ValidatePackageResponse.ResponseDetails, VaultClient.Builder, VaultClient.Settings, VaultObject, VaultObject.ObjectReference, VaultObject.ObjectType, VaultObject.Relationship, VaultObject.Urls, VaultObjectField, VaultObjectField.ObjectReference, VaultObjectPageLayout, VaultObjectPageLayout.PageLayoutRule, VaultObjectPageLayout.PageLayoutSection, VaultObjectPageLayout.PageLayoutSection.LayoutProperty, VaultObjectPageLayout.PageLayoutSection.LayoutProperty.LayoutColumn, VaultObjectPageLayout.PageLayoutSection.LayoutProperty.PropertyItem, VaultResponse, VaultResponse.APIResponseError, VaultResponse.APIResponseWarning
public class VaultModel extends Object
Abstract class that is extended by classes that represent nested objects within an API response.

  • Constructor Details

    • VaultModel

      public VaultModel()

  • Method Details

    • getFieldNames

      public List<String> getFieldNames()

    • getVaultModelData

      public Map<String,Object> getVaultModelData()
      Get all model data
      Returns:
      Map<String, Object%gt;

    • setVaultModelData

      public void setVaultModelData(Map<String,Object> keyValueData)
      Set all model data
      Parameters:
      keyValueData - Map of model data

    • get

      public Object get(String key)
      Get any value from the map by key
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      Object

    • set

      public void set(String key, Object value)
      Add any value to the map by key/value
      Parameters:
      key - field name (Vault name format: example_field__c)
      value - field value

    • getBoolean

      public Boolean getBoolean(String key)
      Get any value from the map by key as Boolean
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      Boolean

    • getInteger

      public Integer getInteger(String key)
      Get any value from the map by key as Integer
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      Integer

    • getListInteger

      public List<Integer> getListInteger(String key)
      Get any value from the map by key as List<Integer%gt;
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      List<Integer%gt;

    • getListString

      public List<String> getListString(String key)
      Get any value from the map by key as List<String%gt;
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      List<String%gt;

    • getListLong

      public List<Long> getListLong(String key)
      Get any value from the map by key as List<Long%gt;
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      List<Long%gt;

    • getLong

      public Long getLong(String key)
      Get any value from the map by key as Long
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      Long

    • getString

      public String getString(String key)
      Get any value from the map by key as String
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      String

    • getBigDecimal

      public BigDecimal getBigDecimal(String key)
      Get any value from the map by key as BigDecimal
      Parameters:
      key - field name (Vault name format: example_field__c)
      Returns:
      BigDecimal

    • toMap

      public Map<String,Object> toMap()
      Converts the existing object into a Map of String/Object
      Returns:
      Map representing all model data

    • toMap

      public Map<String,Object> toMap(boolean convertArrayToString)
      Converts the existing object into a Map of String/Object
      Parameters:
      convertArrayToString - when true, ArrayList of String will be converted to CSV values
      Returns:
      Map representing all model data

    • toJsonString

      public String toJsonString()
      Converts the existing object into a Json String
      Returns:
      String representing all model data

    • toJSONObject

      public com.fasterxml.jackson.databind.JsonNode toJSONObject()
      Converts the existing object into a JSONObject
      Returns:
      JSONObject representing all model data