org.apache.chemistry.opencmis.client.api

Interface QueryResult

public interface QueryResult

Query result.

Method Summary

Modifier and Type	Method and Description
AllowableActions	getAllowableActions() Returns the allowable actions if they have been requested.
List<PropertyData<?>>	getProperties() Returns the list of all properties in this query result.
<T> PropertyData<T>	getPropertyById(String id) Returns a property by ID.
<T> PropertyData<T>	getPropertyByQueryName(String queryName) Returns a property by query name or alias.
<T> List<T>	getPropertyMultivalueById(String id) Returns a property multi-value by ID.
<T> List<T>	getPropertyMultivalueByQueryName(String queryName) Returns a property multi-value by query name or alias.
<T> T	getPropertyValueById(String id) Returns a property (single) value by ID.
<T> T	getPropertyValueByQueryName(String queryName) Returns a property (single) value by query name or alias.
List<Relationship>	getRelationships() Returns the relationships if they have been requested.
List<Rendition>	getRenditions() Returns the renditions if they have been requested.

Method Detail

getProperties

List<PropertyData<?>> getProperties()

Returns the list of all properties in this query result.

Returns:

all properties, not null

getPropertyById

<T> PropertyData<T> getPropertyById(String id)

Returns a property by ID.

Because repositories are not obligated to add property IDs to their query result properties, this method might not always work as expected with some repositories. Use getPropertyByQueryName(String) instead.

Parameters:

id - the property ID

Returns:

the property or null if the property doesn't exist or hasn't been requested

getPropertyByQueryName

<T> PropertyData<T> getPropertyByQueryName(String queryName)

Returns a property by query name or alias.

Parameters:

queryName - the property query name or alias

Returns:

the property or null if the property doesn't exist or hasn't been requested

getPropertyValueById

<T> T getPropertyValueById(String id)

Returns a property (single) value by ID.

Parameters:

id - the property ID

See Also:

getPropertyById(String)

getPropertyValueByQueryName

<T> T getPropertyValueByQueryName(String queryName)

Returns a property (single) value by query name or alias.

Parameters:

queryName - the property query name or alias

Returns:

the property value or null if the property doesn't exist, hasn't been requested, or the property value isn't set

See Also:

getPropertyByQueryName(String)

getPropertyMultivalueById

<T> List<T> getPropertyMultivalueById(String id)

Returns a property multi-value by ID.

Parameters:

id - the property ID

Returns:

the property value or null if the property doesn't exist, hasn't been requested, or the property value isn't set

See Also:

getPropertyById(String)

getPropertyMultivalueByQueryName

<T> List<T> getPropertyMultivalueByQueryName(String queryName)

Returns a property multi-value by query name or alias.

Parameters:

queryName - the property query name or alias

Returns:

the property value or null if the property doesn't exist, hasn't been requested, or the property value isn't set

See Also:

getPropertyByQueryName(String)

getAllowableActions

AllowableActions getAllowableActions()

Returns the allowable actions if they have been requested.

Returns:

the allowable actions if they have been requested, null otherwise

getRelationships

List<Relationship> getRelationships()

Returns the relationships if they have been requested.

Returns:

the relationships if they have been requested, null otherwise

getRenditions

List<Rendition> getRenditions()

Returns the renditions if they have been requested.

Returns:

the rendition if they have been requested, null otherwise