com.starteam
Class Catalog.WebCacheCatalog

java.lang.Object
  com.starteam.Catalog.WebCacheCatalog

Enclosing class:

Catalog

public static final class Catalog.WebCacheCatalog
extends java.lang.Object

The Catalog class provides "global" access to certain properties of objects from different classes. The catalog provides information about Property values for the primary descriptors of objects. Note that the catalog is highly memory intensive and hence extremely expensive Applications should make every effort to retrieve the primary descriptor of an object using all means available before falling back to the catalog

Method Summary

java.lang.Object	get(int objectID, Property.WebCacheProperty prprty) Returns the property value for the specified "object" ID and property.
java.lang.Object	getPrimaryDescriptor(int objectID) Returns the property value for the "primary descriptor" property of the given "object" ID.
Property.WebCacheProperty[]	getProperties() Returns the collection of properties for which this catalog has data.
Type.WebCacheType	getType() Gets the type that owns this catalog.

Methods inherited from class java.lang.Object

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

Method Detail

getPrimaryDescriptor

public java.lang.Object getPrimaryDescriptor(int objectID)

Returns the property value for the "primary descriptor" property of the given "object" ID.

Parameters:

objectID - the object ID for which you want the value.

Returns:

the value of the primary descriptor property or NULL

See Also:

Property.isPrimaryDescriptor()

get

public java.lang.Object get(int objectID,
                            Property.WebCacheProperty prprty)

Returns the property value for the specified "object" ID and property. Will throw an IllegalArgumentException if the object ID is not in the catalog. If the specified ID is not cached in the catalog this method will go to the server to get the catalog data for that ID alone. If still not found the exception is thrown.

Parameters:

objectID - the object ID for requested object

prprty - the requested property

Returns:

the specified property's value for the given object or NULL.

getType

public Type.WebCacheType getType()

Gets the type that owns this catalog.

Returns:

The type that owns this catalog.

getProperties

public Property.WebCacheProperty[] getProperties()

Returns the collection of properties for which this catalog has data.

Returns:

a collection of properties for this catalog.