com.starteam

Class Item.Type.WebCacheItemType

java.lang.Object

com.starteam.Type.WebCacheType

com.starteam.ViewMember.Type.WebCacheViewMemberType

com.starteam.Item.Type.WebCacheItemType

All Implemented Interfaces:

ArtifactCacheManager.Identifiable, ArtifactCacheManager.Nameable, ArtifactCacheManager.SecurableContainer

Direct Known Subclasses:

TreeItem.Type.WebCacheTreeItemType

Enclosing class:

Item.Type

public static class Item.Type.WebCacheItemType
extends ViewMember.Type.WebCacheViewMemberType
implements ArtifactCacheManager.Identifiable

Base accessor for cached SDK types encapsulating the statefulness of objects obtained from the artifact cache.

Method Summary

Modifier and Type	Method and Description
static Item.Type.WebCacheItemType	create(ArtifactCacheManager.Context cntxt, java.lang.String name) Create a new Type.
static Item.Type.WebCacheItemType	fromXml(ArtifactCacheManager.Context cntxt, java.lang.String xmlDefinition) Create a Type from a specified xml definition.
Property.WebCacheProperty	getAssignableProperty() return a property that determines whether this type is one that can be assigned to a user in the context of an ALM process
TextProperty.WebCacheTextProperty	getDescriptionProperty() return a description that determines whether this type is one that provides description information in the context of an ALM process
int	getID() Returns the ID of its underlying object.
int	getIdentifier() returns the integer identifier value of the identifier property
IntegerProperty.WebCacheIntegerProperty	getIdentifierProperty() returns the identifier property for this item type
java.util.Map	getMetaProperties() returns a java.util.Map containing meta properties defined by the client application This feature is new to the 12.0 server Will return an empty Hashtable for 11.0 servers Meta Properties are simply key value pairs.
Property.WebCacheProperty	getPriorityProperty() return a property that determines whether this type is one that provides priority information in the context of an ALM process
EnumeratedProperty.WebCacheEnumeratedProperty	getStatusProperty() return a property that determines whether this type is one that provides status information in the context of an ALM process
Property.WebCacheProperty	getSubTypeProperty() return a property that determines whether this type is one that provides a sub type enumeration in the context of an ALM process
TextProperty.WebCacheTextProperty	getSummaryProperty() return a summary that determines whether this type is one that provides summary information in the context of an ALM process
boolean	isEnabled() Returns true if this type is enabled
boolean	isNew() returns true if this is a new type, i.e.
void	refresh() replace the (possibly out-dated) instance of the contained type with an appropriate read only instance from the ArtifactCache
void	setDisplayName(java.lang.String displayName) Set the display name for instances of Item Types
void	setEnabled(boolean enabled) Enables/disables the type This feature was introduced in the 12.0 server Note that the value of this property is simply a hint to the client application Neither the SDK nor the server ascribe any special meaning to it Only supported for custom components
void	setMetaProperties(java.util.Map properties) saves a java.util.Map containing meta properties defined by the client application This feature is new to the 12.0 server.
void	setProperties(Property.WebCacheProperty[] pp)
java.lang.String	toXml() Returns an xml representation of this type The xml representation is used to specify the type definition when creating custom components
void	update() Save this dirty Type to the Repository Unlike the rest of the sdk objects, types are created from a single parameter, namely an XML string.

Methods inherited from class com.starteam.ViewMember.Type.WebCacheViewMemberType

newBooleanProperty, newContentProperty, newDateProperty, newDateTimeProperty, newDoubleProperty, newEnumeratedProperty, newGroupArrayProperty, newGroupProperty, newIntegerProperty, newLongIntegerProperty, newMapProperty, newTextProperty, newTimeSpanProperty, newUserArrayProperty, newUserProperty

Methods inherited from class com.starteam.Type.WebCacheType

addFilterListener, addQueryListener, equals, findFilter, findFilter, findProperty, findProperty, findQuery, findQuery, getCatalog, getComponentGUID, getContext, getDisplayName, getDisplayNameTranslations, getFilters, getName, getNameProperty, getPrimaryDescriptor, getProperties, getQueries, getRights, getSecondaryDescriptor, getServer, hashCode, setRights

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromXml

public static Item.Type.WebCacheItemType fromXml(ArtifactCacheManager.Context cntxt,
                                                 java.lang.String xmlDefinition)

Create a Type from a specified xml definition. The returned Type object is new, i.e. it is not a server object. It simply represents a data structure mapping Type and Properties to the underlying xml representation. An application may use thus api as a convenient method of serializing xml representations of types out to disk and back, until ready to actually create the type on the server. Note that once a Type has been created on the server, its rendering .xml can no longer be used to manipulate that same type. It could however be used (with appropriate changes to type name, display name, etc) to create a completely different type.

Parameters:

cntxt - The context of the type and its property definitions

xmlDefinition - an xml representation of the type, possibly created using Type and Property objects, then serialized out as an .xml file to disk

Returns:

an Item or Tree Item type as the case may be

create

public static Item.Type.WebCacheItemType create(ArtifactCacheManager.Context cntxt,
                                                java.lang.String name)

Create a new Type. This constructor is only supported on 12.0+ servers. Setting the appropriate properties & saving the type creates a new type on the server. This is equivalent to creating a type using an xml definition.

Parameters:

cntxt - The context of the Web Session

name - the name of the type

Returns:

a new Type or NULL

setProperties

public void setProperties(Property.WebCacheProperty[] pp)

Parameters:

pp - a collection of new property objects which will become the properties of this type. The xml definition of each property will be aggregated into a new type definition which is then streamed to the server

isNew

public boolean isNew()

returns true if this is a new type, i.e. one that has not been saved to the server. New types may be created by extracting their xml definition and creating them through the Server

Returns:

true if this is a new type

See Also:

Server.createType(String, boolean)

isEnabled

public boolean isEnabled()

Returns true if this type is enabled

Returns:

true if this type is enabled

setEnabled

public void setEnabled(boolean enabled)

Enables/disables the type This feature was introduced in the 12.0 server Note that the value of this property is simply a hint to the client application Neither the SDK nor the server ascribe any special meaning to it Only supported for custom components

Parameters:

enabled - true to enable the type, false to disable it

setMetaProperties

public void setMetaProperties(java.util.Map properties)

saves a java.util.Map containing meta properties defined by the client application This feature is new to the 12.0 server. This method will thrown an exception against 11.0 servers. Meta Properties are simply key value pairs. The client application is completely responsible for the keys and their associated values. Neither the SDK nor the server ascribe any particular significance to keys or values Only supported for custom components

Parameters:

properties - the metadata key value pairs to set for this type

getMetaProperties

public java.util.Map getMetaProperties()

returns a java.util.Map containing meta properties defined by the client application This feature is new to the 12.0 server Will return an empty Hashtable for 11.0 servers Meta Properties are simply key value pairs. The client application is completely responsible for the keys and their associated values. Neither the SDK nor the server ascribe any particular significance to keys or values

Returns:

a java.util.Map containing meta properties defined by the client application

getStatusProperty

public EnumeratedProperty.WebCacheEnumeratedProperty getStatusProperty()

return a property that determines whether this type is one that provides status information in the context of an ALM process

Returns:

a status property if this type provides status or NULL

getAssignableProperty

public Property.WebCacheProperty getAssignableProperty()

return a property that determines whether this type is one that can be assigned to a user in the context of an ALM process

Returns:

a user property if this type is assignable or NULL

getPriorityProperty

public Property.WebCacheProperty getPriorityProperty()

return a property that determines whether this type is one that provides priority information in the context of an ALM process

Returns:

a priority property if this type provides it or NULL

getSubTypeProperty

public Property.WebCacheProperty getSubTypeProperty()

return a property that determines whether this type is one that provides a sub type enumeration in the context of an ALM process

Returns:

a sub type property if this type provides it or NULL

getDescriptionProperty

public TextProperty.WebCacheTextProperty getDescriptionProperty()

return a description that determines whether this type is one that provides description information in the context of an ALM process

Returns:

a description property if this type provides it or NULL

getSummaryProperty

public TextProperty.WebCacheTextProperty getSummaryProperty()

return a summary that determines whether this type is one that provides summary information in the context of an ALM process

Returns:

a summary property if this type provides it or NULL

setDisplayName

public void setDisplayName(java.lang.String displayName)

Set the display name for instances of Item Types

Parameters:

displayName - the display name

getID

public int getID()

Returns the ID of its underlying object.

Overrides:

getID in class Type.WebCacheType

Returns:

the class ID for this type.

refresh

public void refresh()

replace the (possibly out-dated) instance of the contained type with an appropriate read only instance from the ArtifactCache

update

public void update()

Save this dirty Type to the Repository Unlike the rest of the sdk objects, types are created from a single parameter, namely an XML string. This is an atomic operation, not executed in a transaction

toXml

public java.lang.String toXml()

Returns an xml representation of this type The xml representation is used to specify the type definition when creating custom components

Returns:

an xml representation of this type

getIdentifier

public int getIdentifier()

returns the integer identifier value of the identifier property

Specified by:

getIdentifier in interface ArtifactCacheManager.Identifiable

Returns:

the integer identifier value of the identifier property

getIdentifierProperty

public IntegerProperty.WebCacheIntegerProperty getIdentifierProperty()

returns the identifier property for this item type

Specified by:

getIdentifierProperty in interface ArtifactCacheManager.Identifiable

Returns:

the identifier property for this item type