org.apache.olingo.odata2.core.uri

Class ExpandSelectTreeNodeImpl.ExpandSelectTreeNodeBuilderImpl

java.lang.Object

org.apache.olingo.odata2.api.uri.ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

org.apache.olingo.odata2.core.uri.ExpandSelectTreeNodeImpl.ExpandSelectTreeNodeBuilderImpl

Enclosing class:

ExpandSelectTreeNodeImpl

public class ExpandSelectTreeNodeImpl.ExpandSelectTreeNodeBuilderImpl
extends ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Constructor Summary

Constructors

Constructor and Description
ExpandSelectTreeNodeBuilderImpl()

Method Summary

Modifier and Type	Method and Description
ExpandSelectTreeNode	build() Will close this builder and return an ExpandSelectTreeNode.
ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder	customExpandedLink(String navigationPropertyName, ExpandSelectTreeNode expandNode) Sets a link to be expanded with a custom node.
ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder	entitySet(EdmEntitySet entitySet) Sets the entitySet for this node.
ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder	expandedLinks(List<String> navigationPropertyNames) A list of expanded links.
ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder	selectedLinks(List<String> selectedNavigationPropertyNames) A list of selected links.
ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder	selectedProperties(List<String> selectedPropertyNames) A list of properties which are selected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpandSelectTreeNodeBuilderImpl

public ExpandSelectTreeNodeBuilderImpl()

Method Detail

entitySet

public ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder entitySet(EdmEntitySet entitySet)

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Sets the entitySet for this node.

Specified by:

entitySet in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Parameters:

entitySet - must not be null

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.

build

public ExpandSelectTreeNode build()
                           throws EdmException

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Will close this builder and return an ExpandSelectTreeNode. All properties and navigation properties will be validated if they exist for the entity set.

Specified by:

build in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.

Throws:

EdmException - in case property or navigation property validation fails.

selectedProperties

public ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder selectedProperties(List<String> selectedPropertyNames)

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

A list of properties which are selected. Selected means that they appear in the payload during serialization. MUST NOT CONTAIN navigation properties.

Specified by:

selectedProperties in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.

selectedLinks

public ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder selectedLinks(List<String> selectedNavigationPropertyNames)

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

A list of selected links. Selected means they appear as links in the payload. If a link should be expanded they navigation property does not need to appear here but can. Expanded links will win over selected links.

Specified by:

selectedLinks in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.

customExpandedLink

public ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder customExpandedLink(String navigationPropertyName,
                                                                           ExpandSelectTreeNode expandNode)

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Sets a link to be expanded with a custom node. With this the inline content can either also be expanded or selected. Custom nodes for a navigation properties will win over navigation properties which are also specified in the expanded links list. Example: if a link A is set with a custom node and A appears in the expanded link list it will be expanded with the custom node.

Specified by:

customExpandedLink in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

expandNode - must not be null

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.

expandedLinks

public ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder expandedLinks(List<String> navigationPropertyNames)

Description copied from class: ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

A list of expanded links. Expanded means their content will be shown as inline entry or feed in the payload but a callback MUST BE registered to get the content for the inline content. The inline content will appear with all properties and links. If this is not needed use the customExpandedLink method to set a custom node for this expanded link. Expanded links will win over selected links. If a custom node was set for a particular link it will win over a link that is specified in this list.

Specified by:

expandedLinks in class ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder

Returns:

ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder for method chaining.