BusinessObjectDefinitionService.java

/*
* Copyright 2015 herd contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.finra.herd.service;

import java.util.Set;
import java.util.concurrent.Future;

import org.finra.herd.model.api.xml.BusinessObjectDefinition;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionCreateRequest;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionDescriptiveInformationUpdateRequest;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionIndexSearchRequest;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionIndexSearchResponse;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionKey;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionKeys;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionSearchRequest;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionSearchResponse;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionUpdateRequest;
import org.finra.herd.model.dto.BusinessObjectDefinitionSampleFileUpdateDto;
import org.finra.herd.model.dto.SearchIndexUpdateDto;

/**
 * The business object definition service.
 */
public interface BusinessObjectDefinitionService
{
    /**
     * Creates a new business object definition.
     *
     * @param businessObjectDefinitionCreateRequest the business object definition create request.
     *
     * @return the created business object definition.
     */
    public BusinessObjectDefinition createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest businessObjectDefinitionCreateRequest);

    /**
     * Updates a business object definition.
     *
     * @param businessObjectDefinitionKey the business object definition key
     * @param businessObjectDefinitionUpdateRequest the business object definition update request
     *
     * @return the updated business object definition
     */
    public BusinessObjectDefinition updateBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey,
        BusinessObjectDefinitionUpdateRequest businessObjectDefinitionUpdateRequest);

    /**
     * Updates a business object definition descriptive information.
     *
     * @param businessObjectDefinitionKey the business object definition key
     * @param businessObjectDefinitionDescriptiveInformationUpdateRequest the business object definition descriptive information update request
     *
     * @return the updated business object definition
     */
    public BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey,
        BusinessObjectDefinitionDescriptiveInformationUpdateRequest businessObjectDefinitionDescriptiveInformationUpdateRequest);

    /**
     * Gets a business object definition for the specified key. This method starts a new transaction.
     *
     * @param businessObjectDefinitionKey the business object definition key
     *
     * @return the business object definition.
     */
    public BusinessObjectDefinition getBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey);

    /**
     * Deletes a business object definition for the specified name.
     *
     * @param businessObjectDefinitionKey the business object definition key
     *
     * @return the business object definition that was deleted.
     */
    public BusinessObjectDefinition deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey);

    /**
     * Gets the list of all business object definitions defined in the system.
     *
     * @return the business object definition keys.
     */
    public BusinessObjectDefinitionKeys getBusinessObjectDefinitions();

    /**
     * Gets a list of all business object definitions defined in the system for a specified namespace.
     *
     * @param namespaceCode the namespace code
     *
     * @return the business object definition keys
     */
    public BusinessObjectDefinitionKeys getBusinessObjectDefinitions(String namespaceCode);

    /**
     * Checks the count of business object definitions in the database against the count of business object definitions in the index.
     *
     * @return boolean value true for valid, false otherwise
     */
    public boolean indexSizeCheckValidationBusinessObjectDefinitions();

    /**
     * Spot check a random percentage of business object definitions in the search index
     *
     * @return boolean value true for valid, false otherwise
     */
    public boolean indexSpotCheckPercentageValidationBusinessObjectDefinitions();

    /**
     * Spot check the most recent business object definitions in the search index
     *
     * @return boolean value true for valid, false otherwise
     */
    public boolean indexSpotCheckMostRecentValidationBusinessObjectDefinitions();

    /**
     * Validate that the search index contains all business object definitions
     *
     * @return result of an asynchronous computation
     */
    public Future<Void> indexValidateAllBusinessObjectDefinitions();

    /**
     * Searches across all business object definitions that are defined in the system per specified search filters and keys
     *
     * @return the retrieved business object definition list
     */
    public BusinessObjectDefinitionSearchResponse searchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest businessObjectDefinitionSearchRequest,
        Set<String> fields);

    /**
     * Searches across all business object definitions that are in search index per specified search filters and keys
     *
     * @return the retrieved business object definition list
     */
    public BusinessObjectDefinitionIndexSearchResponse indexSearchBusinessObjectDefinitions(
        BusinessObjectDefinitionIndexSearchRequest businessObjectDefinitionIndexSearchRequest, Set<String> fields);

    /**
     * Update business object definition sample file
     *
     * @param businessObjectDefinitionKey business object definition key
     * @param businessObjectDefinitionSampleFileUpdateDto update dto
     */
    public void updateBusinessObjectDefinitionEntitySampleFile(BusinessObjectDefinitionKey businessObjectDefinitionKey,
        BusinessObjectDefinitionSampleFileUpdateDto businessObjectDefinitionSampleFileUpdateDto);

    /**
     * Updates the search index document representation of the business object definition.
     *
     * @param searchIndexUpdateDto the SearchIndexUpdateDto object
     */
    public void updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto);
}