com.veeva.vault.sdk.api.data

Interface ObjectMetadataService

All Superinterfaces:

Service

public interface ObjectMetadataService
extends Service

Provides methods to retrieve object and object-field metadata.

Method Summary

Modifier and Type	Method and Description
ObjectField	getField(ObjectFieldRequest request) Retrieves a single ObjectField.
ObjectFieldCollectionResponse	getFields(ObjectFieldCollectionRequest request) Retrieves multiple ObjectField.
ObjectMetadata	getObject(ObjectMetadataRequest request) Retrieves a single ObjectMetadata.
ObjectFieldCollectionRequest.Builder	newFieldCollectionRequestBuilder() Creates an ObjectFieldCollectionRequest.Builder.
ObjectFieldRequest.Builder	newFieldRequestBuilder() Creates an ObjectFieldRequest.Builder.
ObjectMetadataRequest.Builder	newObjectRequestBuilder() Creates an ObjectMetadataRequest.Builder.

Method Detail

newObjectRequestBuilder

ObjectMetadataRequest.Builder newObjectRequestBuilder()

Creates an ObjectMetadataRequest.Builder.

Returns:

an ObjectMetadataRequest.Builder

getObject

ObjectMetadata getObject(ObjectMetadataRequest request)

Retrieves a single ObjectMetadata.

Parameters:

request - the ObjectMetadataRequest containing the information needed to retrieve the object metadata. Cannot be null or empty.

Returns:

a ObjectMetadata containing the metadata of the requested object

newFieldRequestBuilder

ObjectFieldRequest.Builder newFieldRequestBuilder()

Creates an ObjectFieldRequest.Builder.

Returns:

an ObjectFieldRequest.Builder

getField

ObjectField getField(ObjectFieldRequest request)

Retrieves a single ObjectField.

Parameters:

request - the ObjectFieldRequest containing the information needed to fetch the field metadata. Cannot be null or empty.

Returns:

a ObjectField containing the metadata of the requested field

newFieldCollectionRequestBuilder

ObjectFieldCollectionRequest.Builder newFieldCollectionRequestBuilder()

Creates an ObjectFieldCollectionRequest.Builder.

Returns:

an ObjectFieldCollectionRequest.Builder

getFields

ObjectFieldCollectionResponse getFields(ObjectFieldCollectionRequest request)

Retrieves multiple ObjectField.

Parameters:

request - the ObjectFieldCollectionRequest containing the information needed to fetch the bulk ObjectField. Cannot be null or empty.

Returns:

a List of ObjectField containing the metadata of the requested fields