/*
* Copyright 2013 the original author or authors.
*
* 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.socialsignin.spring.data.dynamodb.repository.support;
import java.io.Serializable;
import org.springframework.data.repository.core.EntityInformation;
/**
* Encapsulates minimal information needed to load DynamoDB entities.
*
* As a minimum, provides access to hash-key related metadata.
*
* Implementing classes can elect to be either range-key aware or not. If a
* subclass is not range-key aware it should return null from getRangeKey(ID id)
* method, and return false from isRangeKeyAware and
* isCompositeHashAndRangeKeyProperty methods
*
* @author Michael Lavelle
*/
public interface DynamoDBEntityInformation<T, ID extends Serializable> extends EntityInformation<T, ID>,
DynamoDBHashKeyExtractingEntityMetadata<T> {
boolean isRangeKeyAware();
boolean isCompositeHashAndRangeKeyProperty(String propertyName);
Object getHashKey(ID id);
Object getRangeKey(ID id);
}