com.linkedin.restli.common
Interface ResourceSpec

All Known Implementing Classes:

ResourceSpecImpl

public interface ResourceSpec

Runtime representation of resource spec.

Method Summary

com.linkedin.data.template.DynamicRecordMetadata	getActionResponseMetadata(java.lang.String methodName)
java.lang.Class<?>	getKeyClass()
java.lang.Class<? extends com.linkedin.data.template.RecordTemplate>	getKeyKeyClass()
java.lang.Class<? extends com.linkedin.data.template.RecordTemplate>	getKeyParamsClass()
java.util.Map<java.lang.String,CompoundKey.TypeInfo>	getKeyParts()
com.linkedin.data.template.DynamicRecordMetadata	getRequestMetadata(java.lang.String methodName)
java.util.Set<ResourceMethod>	getSupportedMethods()
java.lang.Class<? extends com.linkedin.data.template.RecordTemplate>	getValueClass()

Method Detail

getSupportedMethods

java.util.Set<ResourceMethod> getSupportedMethods()

Returns:

the set of ResourceMethods supported by the Resource

getKeyClass

java.lang.Class<?> getKeyClass()

Returns:

the class of the key

getValueClass

java.lang.Class<? extends com.linkedin.data.template.RecordTemplate> getValueClass()

Returns:

the RecordTemplate that the Resource Manages

getKeyParts

java.util.Map<java.lang.String,CompoundKey.TypeInfo> getKeyParts()

Returns:

the map of key names to key classes, if the keyClass is a CompoundKey

getKeyKeyClass

java.lang.Class<? extends com.linkedin.data.template.RecordTemplate> getKeyKeyClass()

Returns:

the key of the key, if the keyClass is a ComplexResourceKey

getKeyParamsClass

java.lang.Class<? extends com.linkedin.data.template.RecordTemplate> getKeyParamsClass()

Returns:

the parameters of the key, if the keyClass is a ComplexResourceKey

getRequestMetadata

com.linkedin.data.template.DynamicRecordMetadata getRequestMetadata(java.lang.String methodName)

Parameters:

methodName - the name of the method

Returns:

the DynamicRecordMetadata of the method

getActionResponseMetadata

com.linkedin.data.template.DynamicRecordMetadata getActionResponseMetadata(java.lang.String methodName)

Parameters:

methodName - the name of the method

Returns:

the DynamicRecordMetadata of the Response