com.starteam
Interface CacheService

public interface CacheService

The CacheService is implemented by StarTeam objects that support caching data locally The data will typically have been fetched from the server, and will probably aggregate across multiple contained object instances. Important Note: This interface is not intended to be implemented by client applications. We reserve the right to add methods in the future. Applications that implement this interface may not be compatible with future versions of the StarTeam SDK.

Method Summary

boolean	areElementsPopulated() Determines whether or not this Cache Service has been populated with elements from the repository
void	discard() Discards any cached properties and reduces the memory footprint of the element(s)
boolean	isDiscarded() Returns true if all of the cached properties of the element(s) Item have been discarded They will be re-fetched from the server on demand (even when MPX is enabled).
boolean	isPopulated() Determines whether or not the element(s) have been populated with all available properties this is equivalent to isPopulated(null)
boolean	isPopulated(PropertyCollection properties) Determines whether or not the element(s) have been populated with the specified properties
boolean	isRefreshRequired() Determines whether or not any of the available properties need to be refreshed
boolean	isRefreshRequired(PropertyCollection properties) Determines whether or not any of the given properties need to be refreshed
void	populate() Populates all properties, if necessary this is equivalent to populate(null)
void	populate(PropertyCollection properties) Populates the element(s) with the given properties, if necessary
void	refresh() Refreshes the members of the collection and all available property values, if necessary
void	refresh(PropertyCollection properties) Refreshes the members of the collection and the given property values, if necessary

Method Detail

areElementsPopulated

boolean areElementsPopulated()

Determines whether or not this Cache Service has been populated with elements from the repository

Returns:

true if this Cache Service has been populated with elements from the repository

populate

void populate()

Populates all properties, if necessary this is equivalent to populate(null)

See Also:

CacheService.populate(PropertyCollection)

populate

void populate(PropertyCollection properties)

Populates the element(s) with the given properties, if necessary

Parameters:

properties - the specified set of properties

isPopulated

boolean isPopulated()

Determines whether or not the element(s) have been populated with all available properties this is equivalent to isPopulated(null)

Returns:

true if the element(s) have been populate with all available properties

See Also:

CacheService.isPopulated(PropertyCollection)

isPopulated

boolean isPopulated(PropertyCollection properties)

Determines whether or not the element(s) have been populated with the specified properties

Parameters:

properties - a specified set of properties

Returns:

true if the element(s) have all been populated with the specified properties

isRefreshRequired

boolean isRefreshRequired()

Determines whether or not any of the available properties need to be refreshed

Returns:

true if any of the available properties of the element(s) need to be refreshed

See Also:

CacheService.isRefreshRequired(PropertyCollection)

isRefreshRequired

boolean isRefreshRequired(PropertyCollection properties)

Determines whether or not any of the given properties need to be refreshed

Parameters:

properties - the specified set of properties

Returns:

true if any of these properties need to be refreshed

refresh

void refresh()

Refreshes the members of the collection and all available property values, if necessary

See Also:

CacheService.refresh(PropertyCollection)

refresh

void refresh(PropertyCollection properties)

Refreshes the members of the collection and the given property values, if necessary

Parameters:

properties - the specified set of properties

isDiscarded

boolean isDiscarded()

Returns true if all of the cached properties of the element(s) Item have been discarded They will be re-fetched from the server on demand (even when MPX is enabled).

Returns:

true if all of the cached properties of the element(s) Item have been discarded

discard

void discard()

Discards any cached properties and reduces the memory footprint of the element(s)