/*******************************************************************************
* Copyright 2013 SAP AG
*
* 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 com.sap.core.odata.api.ep.callback;
import com.sap.core.odata.api.ODataCallback;
import com.sap.core.odata.api.exception.ODataApplicationException;
/**
* Callback interface for the $expand query option.
* <p>If an expand clause for a navigation property which points to an entry is found this callback will be called.
* <br>Pointing to an entry means the navigation property has a multiplicity of 0..1 or 1..1.
*
* @author SAP AG
*
*/
public interface OnWriteEntryContent extends ODataCallback {
/**
* Retrieves the data for an entry. See {@link WriteEntryCallbackContext} for details on the context and {@link WriteEntryCallbackResult} for details on the result of this method.
* @param context of this entry
* @return result - must not be null.
* @throws ODataApplicationException
*/
WriteEntryCallbackResult retrieveEntryResult(WriteEntryCallbackContext context) throws ODataApplicationException;
}