com.starteam

Class Type

java.lang.Object

com.starteam.NamedCacheRef

com.starteam.Type

All Implemented Interfaces:

ISecurableContainer, java.lang.Cloneable

Direct Known Subclasses:

TypedResource.Type

public abstract class Type
extends NamedCacheRef
implements ISecurableContainer

Information describing certain StarTeam object types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Type.MetaData server stored meta data available for a Type.
static class	Type.WebCacheType Base accessor for cached SDK types encapsulating the statefulness of objects obtained from the artifact cache.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The type name for Types.

Method Summary

Modifier and Type	Method and Description
void	addFilterQueryListener(IFilterQueryListener listener) Adds a listener for Filter and/or Query events.
void	addTypeListener(TypeListener listener) Adds a listener for Type events.
Type	copy() Creates a copy of a given Type object.
void	discard() discards local changes made to cached properties
void	discardFiltersAndQueries() Discards all cached filter and query information associated with this Type.
boolean	equals(java.lang.Object o) return true if the two types are equal
Catalog	getCatalog() Returns a Catalog object for items of this type.
int	getClassID() Return the class ID for this type.
ACE[]	getComponentACL() Returns the Access Control List for this type.
GUID	getComponentGUID() For Types that correspond to StarTeam components this method returns the server-defined component GUID.
java.lang.String	getDebugString() Returns a String with debug information about this type.
java.lang.String	getDisplayName() Returns a display name for this type.
Translations	getDisplayNameTranslations() Returns a copy of the display name translations for this type.
Filter	getFilter(int ID) Returns the cached Filter object belonging to this type with the specified filter ID.
Filter	getFilter(java.lang.String name) Returns the cached Filter object belonging to this type with the specified filter name.
ACE[]	getFilterACL() Returns the Access Control List for filter of this type.
Filter[]	getFilters() Returns an array of all Filters for this type.
int	getID() Return the class ID for this type.
java.lang.String	getName() Returns the fixed internal name for this type.
ISecurableContainer	getParentContainer() A Type has no parent container.
Property	getPrimaryDescriptor() Gets the one and only primary descriptor of this type.
PropertyCollection	getProperties() Return an array of all Property objects belonging to this type.
Query[]	getQueries() Returns an array of all Query for this type.
Query	getQuery(int ID) Returns the cached Query object belonging to this type with the specified Query ID.
Query	getQuery(java.lang.String name) Returns the cached Query object belonging to this type with the specified Query name.
ACE[]	getQueryACL() Returns the Access Control List for query of this type.
ACE[]	getRights(Type type) Returns the Access Control List for items of the specified type for this type.
Property	getSecondaryDescriptor() Gets a secondary descriptor of this type.
PropertyCollection	getSecondaryDescriptors() Return the set of all secondary descriptors for this type Typically, most types may have at most one secondary descriptor
Server	getServer() Returns the Server object containing this Type.
boolean	hasFilter(int ID) Returns true if the cache contains a Filter with the provided ID.
boolean	hasFilter(java.lang.String name) Returns true if the cache contains a Filter with the provided name.
int	hashCode() return a hash code for this type
boolean	hasPermissions(PermissionCollection permissions) Returns true if desired permissions are granted for this Type.
boolean	hasPermissions(PermissionCollection permissions, Type type) Returns true if desired permissions are granted for items of the specified type for this type.
boolean	hasQuery(int ID) Returns true if the cache contains a Query with the provided ID.
boolean	hasQuery(java.lang.String name) Returns true if the cache contains a Query with the provided name.
boolean	isAttachmentContainer() Returns true if this type can have attachments.
boolean	isBranchable() Returns true if this type is branchable.
boolean	isComponentType() Determines whether or not this Type corresponds to a StarTeam "component".
boolean	isDeleted() always returns false
boolean	isEqualTo(Type type) Compares two Type objects.
boolean	isMPXSupported() Determines whether or not this Type supports MPX.
boolean	isRefreshFiltersAndQueriesRequired() Returns true if a refreshFiltersAndQueries() operation might have resulted in Filter or QueryManager information being updated; returns false if and only if it is known that the Filter and QueryManager information had not been changed since the last refresh.
BooleanProperty	newBooleanProperty(java.lang.String name) Create a new Boolean Property Assigns default display names such that 0=False and 1=True.
ContentProperty	newContentProperty(java.lang.String name) Creates a new ContentProperty.
DateProperty	newDateProperty(java.lang.String name) Creates a new DateProperty
DateTimeProperty	newDateTimeProperty(java.lang.String name) Creates a new DateTimeProperty
DoubleProperty	newDoubleProperty(java.lang.String name) Creates a new DoubleProperty
EnumeratedProperty	newEnumeratedProperty(java.lang.String name, EnumeratedValue[] values, boolean isMultiSelectable) Create a new Enumerated Property
IntegerProperty	newIntegerProperty(java.lang.String name) Creates a new IntegerProperty
LongIntegerProperty	newLongIntegerProperty(java.lang.String name) Creates a new LongIntegerProperty
MapProperty	newMapProperty(java.lang.String name) Creates a new MapProperty.
ObjectArrayProperty	newObjectArrayProperty(java.lang.String name, Principal.Type typeOfValue) Creates a new ObjectArrayProperty Throws an IllegalArgumentException for any typeOfValue other than User or Group
ObjectProperty	newObjectProperty(java.lang.String name, LiveObject.Type typeOfValue) Creates a new ObjectProperty
BooleanProperty	newOnOffProperty(java.lang.String name) Create a new Boolean Property Assigns default display names such that 0=Off and 1=On.
TextProperty	newTextProperty(java.lang.String name) Creates a new TextProperty
TimeSpanProperty	newTimeSpanProperty(java.lang.String name) Creates a new TimeSpanProperty
BooleanProperty	newYesNoProperty(java.lang.String name) Create a new Boolean Property Assigns default display names such that 0=No and 1=Yes.
void	refresh() Updates cached properties to reflect recent changes made on the server.
void	refreshFiltersAndQueries() Refreshes cached Filter and QueryManager information to reflect recent changes to the repository.
void	removeFilterQueryListener(IFilterQueryListener listener) Removes a listener for Filter and/or QueryManager events.
void	removeTypeListener(TypeListener listener) Removes a listener for Type events.
void	setComponentACL(ACE[] acl) Modify the Access Control List for this type.
void	setFilterACL(ACE[] acl) Modify the Access Control List for filter of this type.
void	setQueryACL(ACE[] acl) Modify the Access Control List for query of this type.
void	setRights(Type type, ACE[] acl) Modifies the Access Control List for items of the specified type for this type.
boolean	supportsTraceVersioning() Returns true if this type supports endpoint versioning with traces This feature was introduced in the 16.2 server
java.lang.String	toString() Returns a display string for this Type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

The type name for Types.

See Also:

Type, Constant Field Values

Method Detail

isAttachmentContainer

public boolean isAttachmentContainer()

Returns true if this type can have attachments.

Returns:

true if this type can have attachments.

isBranchable

public boolean isBranchable()

Returns true if this type is branchable.

Returns:

true if this type is branchable.

getPrimaryDescriptor

public Property getPrimaryDescriptor()

Gets the one and only primary descriptor of this type.

Returns:

The primary descriptor of this type, or null if this type has no primary descriptor.

getSecondaryDescriptor

public Property getSecondaryDescriptor()

Gets a secondary descriptor of this type. If the type has multiple secondary descriptors this method will return the first one it locates

Returns:

A secondary descriptor of this type, or null if this type has no secondary descriptor.

getSecondaryDescriptors

public PropertyCollection getSecondaryDescriptors()

Return the set of all secondary descriptors for this type Typically, most types may have at most one secondary descriptor

Returns:

the set of all secondary descriptors for this type

discardFiltersAndQueries

public void discardFiltersAndQueries()

Discards all cached filter and query information associated with this Type. It will be re-fetched from the server on demand (even when MPX is enabled).

See Also:

Type.refreshFiltersAndQueries()

supportsTraceVersioning

public boolean supportsTraceVersioning()

Returns true if this type supports endpoint versioning with traces This feature was introduced in the 16.2 server

Returns:

true if this type supports endpoint versioning with traces, false othrwise

copy

public Type copy()

Creates a copy of a given Type object. Copies associated Properties. Does not copy any associated Filter or Query objects. Useful to applications that want to save a snapshot of the Type in a given state, for example, before calling Server.refreshTypes().

Returns:

A copy of this Type.

See Also:

Type.isEqualTo(Type)

isEqualTo

public boolean isEqualTo(Type type)

Compares two Type objects. Does not compare any associated Property, Filter or QueryManager objects.

Parameters:

type - A Type object to be compared with this one.

Returns:

true if no differences are found.

See Also:

Type.copy()

getServer

public Server getServer()

Returns the Server object containing this Type.

Specified by:

getServer in interface ISecurableContainer

Returns:

the Server object containing this Type.

getCatalog

public Catalog getCatalog()

Returns a Catalog object for items of this type. The catalog is not scoped by View and hence can be used to access Catalog information for any object in any view in the associated server.

Returns:

the catalog for this type or null if this Type does not have a Catalog

getDisplayName

public java.lang.String getDisplayName()

Returns a display name for this type.

Returns:

a display name for this type.

See Also:

Type.getName(), Type.getDBTableName()

getDisplayNameTranslations

public Translations getDisplayNameTranslations()

Returns a copy of the display name translations for this type.

getName

public java.lang.String getName()

Returns the fixed internal name for this type. For example, this is the value you would use on the Server.getTypes().find.

Returns:

the name of this type

See Also:

Type.getDisplayName()

getClassID

public int getClassID()

Return the class ID for this type.

Returns:

the class ID for this type.

See Also:

Type.getID()

getID

public int getID()

Return the class ID for this type.

Specified by:

getID in interface ISecurableContainer

Returns:

the class ID for this type.

See Also:

Type.getClassID()

equals

public boolean equals(java.lang.Object o)

return true if the two types are equal

Overrides:

equals in class java.lang.Object

Parameters:

o - the Type to be tested for equality

Returns:

boolean true if the two types are equal

hashCode

public int hashCode()

return a hash code for this type

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this type

newEnumeratedProperty

public EnumeratedProperty newEnumeratedProperty(java.lang.String name,
                                                EnumeratedValue[] values,
                                                boolean isMultiSelectable)

Create a new Enumerated Property

Parameters:

name - - the name of the property

values - EnumeratedValue[] a default set of enumerated values NULL, or an empty array for a property with no starting values.

isMultiSelectable - true if more than one enumeration is selectable from the list

Returns:

new EnumeratedProperty instance

newBooleanProperty

public BooleanProperty newBooleanProperty(java.lang.String name)

Create a new Boolean Property Assigns default display names such that 0=False and 1=True.

Parameters:

name - - the name of the property

Returns:

new BooleanProperty instance

newContentProperty

public ContentProperty newContentProperty(java.lang.String name)

Creates a new ContentProperty. The new property is dirty; to save changes, you must call Property.update().

Parameters:

name - - the name of the property

Returns:

new ContentProperty instance

newYesNoProperty

public BooleanProperty newYesNoProperty(java.lang.String name)

Create a new Boolean Property Assigns default display names such that 0=No and 1=Yes.

Parameters:

name - - the name of the property

Returns:

new BooleanProperty instance

newOnOffProperty

public BooleanProperty newOnOffProperty(java.lang.String name)

Create a new Boolean Property Assigns default display names such that 0=Off and 1=On.

Parameters:

name - - the name of the property

Returns:

new BooleanProperty instance

newIntegerProperty

public IntegerProperty newIntegerProperty(java.lang.String name)

Creates a new IntegerProperty

Parameters:

name - - the name of the property

Returns:

new IntegerProperty instance

newDoubleProperty

public DoubleProperty newDoubleProperty(java.lang.String name)

Creates a new DoubleProperty

Parameters:

name - - the name of the property

Returns:

new DoubleProperty instance

newDateTimeProperty

public DateTimeProperty newDateTimeProperty(java.lang.String name)

Creates a new DateTimeProperty

Parameters:

name - - the name of the property

Returns:

new DateTimeProperty instance

newDateProperty

public DateProperty newDateProperty(java.lang.String name)

Creates a new DateProperty

Parameters:

name - - the name of the property

Returns:

new DateProperty instance

newLongIntegerProperty

public LongIntegerProperty newLongIntegerProperty(java.lang.String name)

Creates a new LongIntegerProperty

Parameters:

name - - the name of the property

Returns:

new LongIntegerProperty instance

newTimeSpanProperty

public TimeSpanProperty newTimeSpanProperty(java.lang.String name)

Creates a new TimeSpanProperty

Parameters:

name - - the name of the property

Returns:

new TimeSpanProperty instance

newTextProperty

public TextProperty newTextProperty(java.lang.String name)

Creates a new TextProperty

Parameters:

name - - the name of the property

Returns:

new TextProperty instance

newMapProperty

public MapProperty newMapProperty(java.lang.String name)

Creates a new MapProperty. A Map Property supports the assignment of a java Map (i.e. an arbitrary set of key value pairs) as a property value. Currently, the underlying implementation is a text property with the map serialized into a simple xml schema

Parameters:

name - - the name of the property

Returns:

new MapProperty instance

newObjectProperty

public ObjectProperty newObjectProperty(java.lang.String name,
                                        LiveObject.Type typeOfValue)

Creates a new ObjectProperty

Parameters:

name - - the name of the property

typeOfValue - the value type of the new property instance

Returns:

new ObjectProperty instance

newObjectArrayProperty

public ObjectArrayProperty newObjectArrayProperty(java.lang.String name,
                                                  Principal.Type typeOfValue)

Creates a new ObjectArrayProperty Throws an IllegalArgumentException for any typeOfValue other than User or Group

Parameters:

name - - the name of the property

typeOfValue - the value type of the new property instance (currently User or Group)

Returns:

new ObjectArrayProperty instance

toString

public java.lang.String toString()

Returns a display string for this Type. This method calls through to getName().

Overrides:

toString in class java.lang.Object

Returns:

a display string for this type.

isComponentType

public boolean isComponentType()

Determines whether or not this Type corresponds to a StarTeam "component". Standard StarTeam components include, Files, Change Requests, Tasks, Topics, and Audits. In addition the "Project" type is considered a component even though a Folder cannot contain items of that type.

Returns:

true if this Type corresponds to a StarTeam component (FILE, CHANGEREQUEST, TASK, TOPIC, AUDIT or PROJECT).

See Also:

Type.getComponentGUID()

isMPXSupported

public boolean isMPXSupported()

Determines whether or not this Type supports MPX. If a Type supports MPX, then instances of that Type benefit from improved refresh performance on an MPX-enabled server, and can be monitored via event-handling APIs.

Returns:

true if this Type supports MPX (that is, if instances of this Type benefit from improved refresh performance on an MPX-enabled server, and can be monitored via event-handling APIs).

getComponentGUID

public GUID getComponentGUID()

For Types that correspond to StarTeam components this method returns the server-defined component GUID. For all other types this returns null.

Returns:

The server-defined component GUID, or null if this Type does not represent a component type.

See Also:

Type.isComponentType()

getProperties

public PropertyCollection getProperties()

Return an array of all Property objects belonging to this type.

Returns:

an array of all properties belonging to this type.

refreshFiltersAndQueries

public void refreshFiltersAndQueries()

Refreshes cached Filter and QueryManager information to reflect recent changes to the repository. Modifies existing Filter and QueryManager objects in place, whenever possible. If MPX is enabled, refreshFiltersAndQueries() is optimized to avoid unnecessary server commands.

See Also:

Type.getFilters(), Type.getQueries(), Type.isRefreshFiltersAndQueriesRequired(), Type.discardFiltersAndQueries(), Server.enableMPX()

getFilters

public Filter[] getFilters()

Returns an array of all Filters for this type.

Returns:

an array of all Filters for this type.

See Also:

Type.refreshFiltersAndQueries(), Filter

hasFilter

public boolean hasFilter(java.lang.String name)

Returns true if the cache contains a Filter with the provided name.

Parameters:

name - A filter name.

Returns:

true if the cache contains a Filter with the provided name.

See Also:

Type.refreshFiltersAndQueries(), Filter

getFilter

public Filter getFilter(java.lang.String name)

Returns the cached Filter object belonging to this type with the specified filter name. This will not return null, but will throw an IllegalArgumentException if the filter is not found.

Parameters:

name - A filter name.

Returns:

the Filter object belonging to this type with the specified filter name.

See Also:

Type.refreshFiltersAndQueries(), Filter

hasFilter

public boolean hasFilter(int ID)

Returns true if the cache contains a Filter with the provided ID.

Parameters:

ID - A filter ID.

Returns:

true if the cache contains a Filter with the provided ID.

See Also:

Type.refreshFiltersAndQueries(), Filter

getFilter

public Filter getFilter(int ID)

Returns the cached Filter object belonging to this type with the specified filter ID. This will not return null, but will throw an IllegalArgumentException if the filter is not found.

Parameters:

ID - A filter ID.

Returns:

the Filter object belonging to this type with the specified filter ID.

See Also:

Type.refreshFiltersAndQueries(), Filter

getQueries

public Query[] getQueries()

Returns an array of all Query for this type.

Returns:

an array of all Query for this type.

See Also:

Type.refreshFiltersAndQueries(), Query

hasQuery

public boolean hasQuery(java.lang.String name)

Returns true if the cache contains a Query with the provided name.

Parameters:

name - A QueryManager name.

Returns:

true if the cache contains a Query with the provided name.

See Also:

Type.refreshFiltersAndQueries(), Query

getQuery

public Query getQuery(java.lang.String name)

Returns the cached Query object belonging to this type with the specified Query name. This will not return null, but will throw an IllegalArgumentException if the Query is not found.

Parameters:

name - A QueryManager name.

Returns:

the Query object belonging to this type with the specified Query name.

See Also:

Type.refreshFiltersAndQueries(), Query

hasQuery

public boolean hasQuery(int ID)

Returns true if the cache contains a Query with the provided ID.

Parameters:

ID - A QueryManager ID.

Returns:

true if the cache contains a Query with the provided ID.

See Also:

Type.refreshFiltersAndQueries(), Query

getQuery

public Query getQuery(int ID)

Returns the cached Query object belonging to this type with the specified Query ID. This will not return null, but will throw an IllegalArgumentException if the Query is not found.

Parameters:

ID - A QueryManager ID.

Returns:

the Query object belonging to this type with the specified Query ID.

See Also:

Type.refreshFiltersAndQueries(), Query

getComponentACL

public ACE[] getComponentACL()

Returns the Access Control List for this type. This will return null if this type has no access control list.

Returns:

the access control list for this type. May return null.

setComponentACL

public void setComponentACL(ACE[] acl)

Modify the Access Control List for this type. If the input parameter is null then the access control list will be dropped.

Parameters:

acl - the new access control list or null if to be dropped.

getFilterACL

public ACE[] getFilterACL()

Returns the Access Control List for filter of this type. This will return null if this type has no access control list.

Returns:

the access control list for this type. May return null.

setFilterACL

public void setFilterACL(ACE[] acl)

Modify the Access Control List for filter of this type. If the input parameter is null then the access control list will be dropped.

Parameters:

acl - the new access control list or null if to be dropped.

getQueryACL

public ACE[] getQueryACL()

Returns the Access Control List for query of this type. This will return null if this type has no access control list.

Returns:

the access control list for this type. May return null.

setQueryACL

public void setQueryACL(ACE[] acl)

Modify the Access Control List for query of this type. If the input parameter is null then the access control list will be dropped.

Parameters:

acl - the new access control list or null if to be dropped.

isRefreshFiltersAndQueriesRequired

public boolean isRefreshFiltersAndQueriesRequired()

Returns true if a refreshFiltersAndQueries() operation might have resulted in Filter or QueryManager information being updated; returns false if and only if it is known that the Filter and QueryManager information had not been changed since the last refresh. If MPX is not enabled, then isRefreshFiltersAndQueriesRequired() always returns true.

Returns:

true if Filter or QueryManager information may be out of date.

See Also:

Type.refreshFiltersAndQueries(), Server.enableMPX()

addTypeListener

public void addTypeListener(TypeListener listener)

Adds a listener for Type events.

Event handlers will be triggered whenever this Type is changed on the server.

In order to handle events, an application must enable MPX.

Parameters:

listener - Application-specific event handler for Type events.

See Also:

TypeListener, Type.removeTypeListener(com.starteam.events.TypeListener), Server.enableMPX()

removeTypeListener

public void removeTypeListener(TypeListener listener)

Removes a listener for Type events.

Parameters:

listener - Previously-registered event handlers for Type events.

See Also:

TypeListener, Type.addTypeListener(com.starteam.events.TypeListener)

addFilterQueryListener

public void addFilterQueryListener(IFilterQueryListener listener)

Adds a listener for Filter and/or Query events.

Event handlers will be triggered whenever a Filter or Query of this Type is added, changed or deleted on the server. Note that an application will not receive events for Filters or Queries that the logged-in user does not have permission to access.

In order to handle events, an application must enable MPX.

Parameters:

listener - Application-specific event handler for Filter and/or QueryManager events. Any class that implements the FilterListener or QueryListener interface (or both) is supported.

See Also:

IFilterQueryListener, FilterListener, QueryListener, Type.removeFilterQueryListener(com.starteam.events.IFilterQueryListener), Server.enableMPX()

removeFilterQueryListener

public void removeFilterQueryListener(IFilterQueryListener listener)

Removes a listener for Filter and/or QueryManager events.

Parameters:

listener - Previously-registered event handlers for Filter and/or QueryManager events.

See Also:

IFilterQueryListener, Type.addFilterQueryListener(com.starteam.events.IFilterQueryListener)

getDebugString

public java.lang.String getDebugString()

Returns a String with debug information about this type.

Returns:

a debug string for this type.

See Also:

Type.getDisplayName()

getParentContainer

public ISecurableContainer getParentContainer()

A Type has no parent container. It returns null.

Specified by:

getParentContainer in interface ISecurableContainer

Returns:

null.

See Also:

ISecurableContainer

getRights

public ACE[] getRights(Type type)

Returns the Access Control List for items of the specified type for this type.

Specified by:

getRights in interface ISecurableContainer

Parameters:

type - the name of the type being controlled by the returned ACL

Returns:

the access control list for this type or NULL.

See Also:

ACE, Type

setRights

public void setRights(Type type,
                      ACE[] acl)

Modifies the Access Control List for items of the specified type for this type. If the ACL is null then the access control list for items of the specified type will be dropped. If typeName does not specify the type itself, an exception will be thrown.

Specified by:

setRights in interface ISecurableContainer

Parameters:

type - the type being controlled by the returned ACL

acl - the new access control list or null if to be dropped

See Also:

ACE, Type

hasPermissions

public boolean hasPermissions(PermissionCollection permissions)

Returns true if desired permissions are granted for this Type. If the type itself is a non-"Item" type, it always returns false.

Parameters:

permissions - the desired permissions

See Also:

Permission

hasPermissions

public boolean hasPermissions(PermissionCollection permissions,
                              Type type)

Returns true if desired permissions are granted for items of the specified type for this type. If the type itself is a non-"Item" type, it always returns false.

Specified by:

hasPermissions in interface ISecurableContainer

Parameters:

permissions - the desired permissions

type - the type for access to be tested on

Returns:

true if all the requested permissions are granted; false if at least one of the requested permissions is denied.

See Also:

Permission

refresh

public void refresh()

Updates cached properties to reflect recent changes made on the server. This is an expensive operation, since it will always execute a server command

discard

public void discard()

discards local changes made to cached properties

isDeleted

public boolean isDeleted()

always returns false

Specified by:

isDeleted in interface ISecurableContainer

Returns:

true if this object has been deleted