com.starteam
Class View

java.lang.Object
  com.starteam.TypedResource
      com.starteam.LiveObject
          com.starteam.View

All Implemented Interfaces:

ISecurable, ISecurableContainer, java.lang.Cloneable

Direct Known Subclasses:

MergePreview, RecycleBin

public class View
extends LiveObject
implements ISecurable, ISecurableContainer

Represents a StarTeam View.

Nested Class Summary

static class	View.Type Type for view
static class	View.ViewType Defines the Types of a View This property is new to 12.0+ servers
static class	View.WebCacheView View accessor for cached SDK views contained objects are obtained from the artifact cache

Nested classes/interfaces inherited from class com.starteam.LiveObject

LiveObject.WebCacheLiveObject

Nested classes/interfaces inherited from class com.starteam.TypedResource

TypedResource.BranchState

Constructor Summary

View(View parent, boolean bIsVariantView, boolean bIsROView, java.lang.String name, java.lang.String description, Folder rootFolder, java.lang.String defaultWorkingFolder, ViewConfiguration baseConfig, boolean bIsBranched)
A constructor used to create a new view.

View(View parent, java.lang.String name, java.lang.String description, java.lang.String defaultWorkingFolder)
A constructor used to create a blank view.

View(View view, ViewConfiguration configuration)
A view "copy" constructor that allows the specification of an arbitrary configuration.

Method Summary

void	addFolderListener(IFolderListener listener) Adds a listener for Folder-related events.
void	addFolderUpdateListener(FolderUpdateListener listener) Listens for updates to this view's folder tree.
void	addItemListener(IItemListener listener, Item.Type type) Adds a listener for Item-related events.
void	addItemListener(IItemListener listener, Item.Type type, PropertyCollection properties) Adds a listener for Item-related events.
void	addItemUpdateListener(ItemUpdateListener listener, Item.Type type) Listens for updates to the items of a given type in this view.
void	addLabelListener(LabelListener listener) Adds a listener for Label events.
void	addViewListener(ViewListener listener) Adds a listener for View events.
void	addViewMemberListener(ViewMemberListener listener, ViewMember.Type type) Adds a listener for non-Item ViewMember-related events.
void	addViewMemberListener(ViewMemberListener listener, ViewMember.Type type, PropertyCollection properties) Adds a listener for non-Item ViewMember-related events.
void	addViewMemberUpdateListener(ViewMemberUpdateListener listener, ViewMember.Type type) Listens for updates to the view members of a given type in this view.
Label	cloneRevisionLabel(Label source, java.lang.String name, java.lang.String description, boolean frozen) Clones the specified "Revision" label.
Label	cloneViewLabel(Label source, java.lang.String name, java.lang.String description, boolean buildLabel, boolean frozen) Clones the specified "View" label.
void	close() Frees all cached resources associated with this view, and closes the associated view session.
View	copy() Creates a copy of this View object, with view properties fully populated.
CheckinManager	createCheckinManager() Constructs a CheckinManager with default options for this view.
CheckinManager	createCheckinManager(CheckinOptions options) Constructs a CheckinManager using a specific set of options.
CheckoutManager	createCheckoutManager() Constructs a CheckoutManager with default options for this view.
CheckoutManager	createCheckoutManager(CheckoutOptions options) Constructs a CheckoutManager using a specific set of options.
View	createChildViewShareAllItems(java.lang.String name, java.lang.String description, Folder rootFolder, java.lang.String defaultWorkingFolder, ViewConfiguration baseConfig, boolean bIsBranched) Create a new variant view as a child of this view, that initially shares items of all item types supported on this server.
View	createChildViewShareDefaultItems(java.lang.String name, java.lang.String description, Folder rootFolder, java.lang.String defaultWorkingFolder, ViewConfiguration baseConfig, boolean bIsBranched) Create a new variant view as a child of this view, that initially shares items of the default set of item types defined for this view's Project.
View	createChildViewShareNoItems(java.lang.String name, java.lang.String description, Folder rootFolder, java.lang.String defaultWorkingFolder, ViewConfiguration baseConfig, boolean bIsBranched) Create a new variant view as a child of this view, that initially shares no items.
View	createChildViewShareTheseItems(java.lang.String name, java.lang.String description, Folder rootFolder, java.lang.String defaultWorkingFolder, ViewConfiguration baseConfig, boolean bIsBranched, TypeCollection types) Create a new variant view as a child of this view, that initially shares items based on the set of item Types provided.
Label	createRevisionLabel(java.lang.String name, java.lang.String description, boolean frozen) Create a new "Revision" label with the specified properties.
Label	createViewLabel(java.lang.String name, java.lang.String description, DateTime time, boolean buildLabel, boolean frozen) Create a new "View" label with the specified properties.
void	discard() Discards all of the cached properties for this view.
void	discardActiveLabels() Discard any cached active (non-deleted) labels.
void	discardFolders() Discards all cached Folder information.
void	discardLabels() Discards cached Label information.
boolean	equals(java.lang.Object another) Returns true if the specified object identifies the same view as this one.
Label[]	fetchAllLabels() Returns all the active (non-deleted) labels for this view.
Label[]	fetchAllLabels(View view) Returns all the active (non-deleted) labels for any given View
View	findDerivedView(java.lang.String name) Return an immediate derived view with the specified name or NULL if none exist
Folder	findFolder(int itemID) Returns a Folder in the View, given its Item ID, or NULL if none found.
Item	findItem(Item.Type type, int itemID) Returns an Item in the View, given its Type and Item ID, or NULL if none found.
Label	findLabel(int labelID) find and return a Label given it's label ID
Label	findLabel(java.lang.String labelName) find and return a label given its name
ViewMember	findViewMember(ViewMember.Type type, int VMID) Returns a ViewMember in the View, given its Type and VMID, or NULL if none found.
Label[]	getActiveLabels() Returns all the active (non-deleted) labels for this view.
java.lang.String	getAlternatePath() Returns the alternate working file path to be used for this view.
ViewConfiguration	getBaseConfiguration() Returns the ViewConfiguration from which this View was derived.
ChangePackageCollection	getChangePackages() Gets the change packages contained in this view.
ViewConfiguration	getConfiguration() Returns this view's configuration.
DateTime	getCreatedTime() Returns the time at which the view was created.
java.lang.String	getDefaultPath() Returns the default working file path to be used for this view.
View[]	getDerivedViews() Returns the set of views derived from this one.
java.lang.String	getDescription() Returns the description of this view.
Item	getDisembodiedItem(Item.Type type, int itemID) Retrieves an Item by Item ID.
ViewMember	getDisembodiedViewMember(ViewMember.Type type, int vmID) Retrieves a ViewMember by VMID.
DateTime	getEndDate() Gets the end date of this view.
FileBasedStatusManager	getFileStatusManager() Get the FileBasedStatusManager that manages file status information for this View.
java.lang.String	getFullName() Returns the full hierarchical name of this view--that is, the concatenation of the root view and each descendant to this view.
int	getID() Returns the unique integer identifier for this view.
Label[]	getLabels() Returns the labels that exist in this view, including both active and deleted labels.
java.lang.String	getName() Returns the name of this view.
ViewMemberCollection	getNewNotificationItems(Item.Type type) Return the list of "notification" items for the specified type.
ISecurableContainer	getParentContainer() If there are no access rights explicitly assigned to this object, then the effective access rights come from a parent container.
View	getParentView() Returns the parent of this view.
java.lang.String	getPath() Returns the working file path being used for this view.
int	getPresentationID() Returns the unique integer identifier for this view.
Project	getProject() Returns the project to which this view belongs.
PromotionModel	getPromotionModel() Returns the promotion model associated with this view.
View.Type.PropertyCollection	getProperties()
RecycleBin	getRecycleBin() Provides access to the items that have been deleted from a view.
ACE[]	getRights() Returns the Access Control List for this view.
ACE[]	getRights(Type type) Returns the Access Control List for items of the specified type for this view.
Folder	getRootFolder() Gets the root folder of this view.
Server	getServer() Returns the server to which this view belongs.
DateTime	getStartDate() Gets the start date of this view.
StatusMethod	getStatusMethodOverride() Returns the status method used to determine status for files in this view.
TraceCollection	getTraces() Gets the traces which exists in this view.
java.lang.Object	getValue(Property property) Return the value for the specified property.
int	getViewID() Returns the unique integer identifier for this view.
ViewMemberCollection	getViewMembers(ViewMember.Type type) Gets the view members of the given type contained in this view.
View.ViewType	getViewType() Gets the type (Unknown, Main, Sandbox, Release) of this View.
Workflow	getWorkflow(ViewMember.Type typ) Returns the type specific workflow definition for this view, if any If a workflow has not been defined for the view, but a project wide workflow has been defined for the type, the project workflow is returned If a project wide workflow has not been defined then the server wide workflow for the type is returned.
int	hashCode() Returns a hash code for this view.
boolean	hasNewNotificationItems(Item.Type type) Return true if any new notification items are available in this view for the specified item type.
boolean	hasPermissions(PermissionCollection permissions) Returns true if desired permissions are granted for this view
boolean	hasPermissions(PermissionCollection permissions, Type type) Returns true if desired permissions are granted for items of the specified type for this view
boolean	isAccessible() Determines whether or not the logged on user has access to this view.
boolean	isBranch() Return true if this view is a Branch view.
boolean	isBranchAll() Return true if this view's original branching default was set "All".
boolean	isBranchNone() Return true if this view's original branching default was set "None".
boolean	isBranchOnShare() Returns true if this view is set to branch shared items.
boolean	isDeleted() Determines whether or not this view has been deleted from the server.
boolean	isEqualTo(View view) Compares the properties of two Views.
boolean	isNonDerived() Return true if this view is a Non-Derived view.
boolean	isReadOnly() Return true if this is a ReadOnly view, otherwise false.
boolean	isReference() Return true if this is a reference view, otherwise false.
boolean	isRefreshActiveLabelsRequired() Returns true if a refreshLabels() operation might have resulted in Label information for active (non-deleted) labels being updated; returns false if and only if it is known that the Labels had not been changed since the last refresh.
boolean	isRefreshFoldersRequired() Returns true if a View.refreshFolders() operation might have resulted in Folder information being updated; returns false if and only if it is known that the folders had not been changed since the last refresh.
boolean	isRefreshLabelsRequired() Returns true if a refreshLabels() operation might have resulted in Label information being updated; returns false if and only if it is known that the Labels had not been changed since the last refresh.
boolean	isRefreshRequired() Returns true if a refresh() operation might have resulted in view properties being updated; returns false if and only if it is known that the view properties had not been changed since the last refresh.
boolean	isRoot() Return true if this view is a Root view.
void	populate() Populates view properties, if they have not already been populated.
void	refresh() Updates cached properties to reflect recent changes made on the server.
void	refreshActiveLabels() Refreshes cached Label information for active (non-deleted) labels to reflect recent changes to the repository.
void	refreshFolders() Updates cached Folder information to reflect recent changes to the server.
void	refreshLabels() Refreshes cached Label information to reflect recent changes to the repository.
void	refreshPromotionModel() Refreshes the local cached information about this view's promotion model.
void	remove() Removes the view from the server.
void	removeFolderListener(IFolderListener listener) Removes a listener for Folder-related events.
void	removeFolderUpdateListener(FolderUpdateListener listener) Removes a listener for folder update events.
void	removeItemListener(IItemListener listener, Item.Type type) Removes a listener for Item-related events.
void	removeItemUpdateListener(ItemUpdateListener listener, Item.Type type) Removes a listener for item update events.
void	removeLabelListener(LabelListener listener) Removes a listener for Label events.
void	removeViewListener(ViewListener listener) Removes a listener for View events.
void	removeViewMemberListener(ViewMemberListener listener, ViewMember.Type type) Removes a listener for non-Item ViewMember-related events.
void	removeViewMemberUpdateListener(ViewMemberUpdateListener listener, ViewMember.Type type) Removes a listener for view member update events.
Item	resolveLinkEndpoint(Link.Endpoint endpoint) Returns the item in this view referred to by the LinkEndpoint.
void	setAlternatePath(java.lang.String path) Sets the alternate working file path to be used for this view.
void	setBranchOnShare(boolean branchOnShare) Sets the Branch On Share behavior for this view (only on servers that support it).
void	setDefaultPath(java.lang.String path) Sets the default working file path to be used for this view.
void	setDescription(java.lang.String description) Sets the description for this view.
void	setEndDate(DateTime endDate) Sets the end date of this view.
void	setName(java.lang.String name) Set the name of this view.
void	setRights(ACE[] acl) Modify the Access Control List for this view.
void	setRights(Type type, ACE[] acl) Modifies the Access Control List for items of the specified type for this view.
void	setStartDate(DateTime startDate) Sets the start date of this view.
void	setStatusMethodOverride(StatusMethod method) Changes the status method to use for files in this view.
java.lang.Object	setValue(Property property, java.lang.Object value) Sets the value of the specified property and return the old value.
void	setViewType(View.ViewType type) Sets the type of this View.
java.lang.String	toString() Returns the name of this view.
void	update() Persists this view's properties to its Server.

Methods inherited from class com.starteam.LiveObject

getCreatedBy, toStarTeamURL

Methods inherited from class com.starteam.TypedResource

addToIntegerArray, getBooleanValue, getByteArrayValue, getCachedProperties, getContentValue, getDateTimeValue, getDateValue, getDisplayName, getDoubleValue, getEnumDisplayName, getEnumeratedValues, getIntegerArrayValue, getIntegerValue, getLinkValue, getLongValue, getObjectID, getPossibleValues, getStringValue, getTimeSpanValue, getType, hasCachedProperties, hasValue, isDirty, isNew, removeFromIntegerArray, setBooleanValue, setByteArrayValue, setContentValue, setDateTimeValue, setDateValue, setDoubleValue, setEnumeratedValue, setEnumeratedValues, setIntegerArrayValue, setIntegerValue, setLinkValue, setLongValue, setStringValue, setTimeSpanValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.starteam.ISecurable

getType

Constructor Detail

View

public View(View parent,
            boolean bIsVariantView,
            boolean bIsROView,
            java.lang.String name,
            java.lang.String description,
            Folder rootFolder,
            java.lang.String defaultWorkingFolder,
            ViewConfiguration baseConfig,
            boolean bIsBranched)

A constructor used to create a new view.

Parameters:

parent - the new view's parent view.

bIsVariantView - true for a variant view, false for a reference view.

bIsROView - true for a read-only view, false for a normal view.

name - the new view's name.

description - the new view's description.

rootFolder - the root folder for the view. This must be a valid folder from the specified configuration of the parent view.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

baseConfig - the ViewConfiguration for the view. For a derived view, specify the parent view's configuration. For a floating view, specify a "current" configuration.

bIsBranched - true for branch on change. Sets initial branching behavior in derived variant views for all items shared during the view creation from the active view. Specify true for default branching, false for default floating.

See Also:

ViewConfiguration

View

public View(View parent,
            java.lang.String name,
            java.lang.String description,
            java.lang.String defaultWorkingFolder)

A constructor used to create a blank view.

Parameters:

parent - the new view's parent view.

name - the new view's name.

description - the new view's description.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

View

public View(View view,
            ViewConfiguration configuration)

A view "copy" constructor that allows the specification of an arbitrary configuration. This does not really create a new view on the server but rather creates a client side View object set to the specified configuration.

Parameters:

view - the view being configured

configuration - the desired configuration of the specified view.

Method Detail

getProperties

public View.Type.PropertyCollection getProperties()

createChildViewShareAllItems

public View createChildViewShareAllItems(java.lang.String name,
                                         java.lang.String description,
                                         Folder rootFolder,
                                         java.lang.String defaultWorkingFolder,
                                         ViewConfiguration baseConfig,
                                         boolean bIsBranched)

Create a new variant view as a child of this view, that initially shares items of all item types supported on this server.

Parameters:

name - the new view's name.

description - the new view's description.

rootFolder - the root folder for the view. This must be a valid folder from the specified configuration of the parent view.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

baseConfig - the ViewConfiguration for the view. Specify the configuration of this view that is used as a starting point for the new variant view.

bIsBranched - true for branch on change. Sets initial branching behavior for all items shared from this view during view creation. Specify true for default branching, false for default floating.

Returns:

the new variant view.

See Also:

ViewConfiguration

createChildViewShareDefaultItems

public View createChildViewShareDefaultItems(java.lang.String name,
                                             java.lang.String description,
                                             Folder rootFolder,
                                             java.lang.String defaultWorkingFolder,
                                             ViewConfiguration baseConfig,
                                             boolean bIsBranched)

Create a new variant view as a child of this view, that initially shares items of the default set of item types defined for this view's Project.

Parameters:

name - the new view's name.

description - the new view's description.

rootFolder - the root folder for the view. This must be a valid folder from the specified configuration of the parent view.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

baseConfig - the ViewConfiguration for the view. Specify the configuration of this view that is used as a starting point for the new variant view.

bIsBranched - true for branch on change. Sets initial branching behavior for all items shared from this view during view creation. Specify true for default branching, false for default floating.

Returns:

the new variant view.

See Also:

ViewConfiguration

createChildViewShareNoItems

public View createChildViewShareNoItems(java.lang.String name,
                                        java.lang.String description,
                                        Folder rootFolder,
                                        java.lang.String defaultWorkingFolder,
                                        ViewConfiguration baseConfig,
                                        boolean bIsBranched)

Create a new variant view as a child of this view, that initially shares no items. Supported on servers beginning with release 10.3.

Parameters:

name - the new view's name.

description - the new view's description.

rootFolder - the root folder for the view. This must be a valid folder from the specified configuration of the parent view.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

baseConfig - the ViewConfiguration for the view. Specify the configuration of this view that is used as a starting point for the new variant view.

bIsBranched - true for branch on change. Sets initial branching behavior for all items shared from this view during view creation. Specify true for default branching, false for default floating.

Returns:

the new variant view.

See Also:

ViewConfiguration

createChildViewShareTheseItems

public View createChildViewShareTheseItems(java.lang.String name,
                                           java.lang.String description,
                                           Folder rootFolder,
                                           java.lang.String defaultWorkingFolder,
                                           ViewConfiguration baseConfig,
                                           boolean bIsBranched,
                                           TypeCollection types)

Create a new variant view as a child of this view, that initially shares items based on the set of item Types provided. Supported on servers beginning with release 10.3.

Parameters:

name - the new view's name.

description - the new view's description.

rootFolder - the root folder for the view. This must be a valid folder from the specified configuration of the parent view.

defaultWorkingFolder - the default working folder path for the view. This can be overridden on each workstation as needed.

baseConfig - the ViewConfiguration for the view. Specify the configuration of this view that is used as a starting point for the new variant view.

bIsBranched - true for branch on change. Sets initial branching behavior for all items shared from this view during view creation. Specify true for default branching, false for default floating.

types - an array containing the set of Types of the items that will initially be shared from this view during view creation.

Returns:

the new variant view.

See Also:

ViewConfiguration, View.ViewType

getValue

public java.lang.Object getValue(Property property)
                          throws NoSuchPropertyException

Return the value for the specified property.

Overrides:

getValue in class TypedResource

Parameters:

property - the property to be retrieved

Returns:

the value of the specified property

Throws:

NoSuchPropertyException - if the named property does not exist

setValue

public java.lang.Object setValue(Property property,
                                 java.lang.Object value)
                          throws NoSuchPropertyException,
                                 java.lang.ClassCastException

Sets the value of the specified property and return the old value.

Overrides:

setValue in class TypedResource

Parameters:

property - the property to set

value - the new value to set for the specified property

Returns:

the old property value

Throws:

NoSuchPropertyException - if the named property does not exist

java.lang.ClassCastException - if the value is of the wrong type for the specified property

populate

public void populate()

Populates view properties, if they have not already been populated.

See Also:

View.refresh()

isRefreshRequired

public boolean isRefreshRequired()

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

Returns:

true if view properties may be out of date.

See Also:

View.refresh(), Server.enableMPX()

refresh

public void refresh()

Updates cached properties to reflect recent changes made on the server. If MPX is enabled, refresh() is optimized to avoid unnecessary server commands.

See Also:

View.isRefreshRequired(), View.populate(), Server.enableMPX()

copy

public View copy()

Creates a copy of this View object, with view properties fully populated. Useful to applications that want to save a snapshot of the View in a given state, for example, before calling refresh().

Returns:

A new copy of this View object.

See Also:

View.isEqualTo(com.starteam.View)

isEqualTo

public boolean isEqualTo(View view)

Compares the properties of two Views.

Parameters:

view - The view to be compared to this one.

Returns:

true if no differences were found.

See Also:

View.copy()

isReference

public boolean isReference()

Return true if this is a reference view, otherwise false.

Returns:

true if this is a reference view, otherwise false.

isReadOnly

public boolean isReadOnly()

Return true if this is a ReadOnly view, otherwise false.

Returns:

true if this view is ReadOnly, otherwise false.

isRoot

public boolean isRoot()

Return true if this view is a Root view.

Returns:

true if this view is a Root view.

isBranch

public boolean isBranch()

Return true if this view is a Branch view.

Returns:

true if this view is a Branch view.

isNonDerived

public boolean isNonDerived()

Return true if this view is a Non-Derived view.

Returns:

true if this view is Non-Derived view.

isBranchAll

public boolean isBranchAll()

Return true if this view's original branching default was set "All".

Returns:

true if this view's original branching default was set "All".

isBranchNone

public boolean isBranchNone()

Return true if this view's original branching default was set "None".

Returns:

true if this view's original branching default was set "None".

isBranchOnShare

public boolean isBranchOnShare()

Returns true if this view is set to branch shared items.

Returns:

true if this view is set to branch shared items.

setBranchOnShare

public void setBranchOnShare(boolean branchOnShare)
                      throws NoSuchPropertyException

Sets the Branch On Share behavior for this view (only on servers that support it).

Parameters:

branchOnShare - true = branch shared items.

Throws:

NoSuchPropertyException

isAccessible

public boolean isAccessible()

Determines whether or not the logged on user has access to this view.

Returns:

true if the logged on user has access to this view.

See Also:

Project.getAccessibleViews()

getViewID

public int getViewID()

Returns the unique integer identifier for this view.

Returns:

the unique integer identifier for this view.

Throws:

java.lang.RuntimeException - if the user does not have the right to access the view

See Also:

View.getID(), View.isAccessible()

getID

public int getID()

Returns the unique integer identifier for this view.

Specified by:

getID in interface ISecurable

Specified by:

getID in interface ISecurableContainer

Overrides:

getID in class TypedResource

Returns:

the unique integer identifier for this view. Same as getViewID.

See Also:

View.getViewID()

getPresentationID

public int getPresentationID()

Returns the unique integer identifier for this view. on pre 14.0 servers, it returns the viewID

Returns:

the unique integer identifier for this view.

getLabels

public Label[] getLabels()

Returns the labels that exist in this view, including both active and deleted labels. The labels are cached until explicitly refreshed.

Returns:

The labels (both active and deleted) that exist in this view.

See Also:

View.refreshLabels(), View.getActiveLabels()

getActiveLabels

public Label[] getActiveLabels()

Returns all the active (non-deleted) labels for this view. The labels are cached until explicitly refreshed.

Returns:

The active (non-deleted) labels for this view.

See Also:

View.refreshActiveLabels(), View.getLabels()

findLabel

public Label findLabel(java.lang.String labelName)

find and return a label given its name

Parameters:

labelName - the name to query for

Returns:

a label matching the specified name or NULL if none found

findLabel

public Label findLabel(int labelID)

find and return a Label given it's label ID

Parameters:

labelID - the ID to query for

Returns:

a Label matching the specified ID, or NULL if none found

discardActiveLabels

public void discardActiveLabels()

Discard any cached active (non-deleted) labels. Subsequent calls to getActiveLabels() will fetch the label information from the StarTeam Server (even when MPX is enabled).

See Also:

View.getActiveLabels(), View.refreshActiveLabels(), Server.enableMPX()

isRefreshActiveLabelsRequired

public boolean isRefreshActiveLabelsRequired()

Returns true if a refreshLabels() operation might have resulted in Label information for active (non-deleted) labels being updated; returns false if and only if it is known that the Labels had not been changed since the last refresh. If MPX is not enabled, then isRefreshLabelsRequired() always returns true.

Returns:

true if the active label information may be out of date.

See Also:

View.refreshActiveLabels(), Server.enableMPX()

refreshActiveLabels

public void refreshActiveLabels()

Refreshes cached Label information for active (non-deleted) labels to reflect recent changes to the repository. Modifies existing Label objects in place whenever possible. If MPX is enabled, refreshActiveLabels() is optimized to avoid unnecessary server commands.

See Also:

View.isRefreshActiveLabelsRequired(), View.getActiveLabels(), View.discardActiveLabels(), View.refreshLabels(), Server.enableMPX()

fetchAllLabels

public Label[] fetchAllLabels()

Returns all the active (non-deleted) labels for this view.

The labels are not cached in the View object. Each call to fetchAllLabels() returns an up-to-date list consisting of newly allocated Label objects.

If MPX is enabled, fetchAllLabels() is optimized to avoid unnecessary server commands.

Returns:

The active (non-deleted) labels for this view. May be empty (but is never null).

fetchAllLabels

public Label[] fetchAllLabels(View view)

Returns all the active (non-deleted) labels for any given View

The labels are not cached. Each call to fetchAllLabels() returns an up-to-date list consisting of newly allocated Label objects.

fetchAllLabels() is not MPX-enabled; the labels are always retrieved directly from the repository.

Parameters:

view - the view whose labels are to be fetched

Returns:

The active (non-deleted) labels for the given project and view. May be empty (but is never null).

createViewLabel

public Label createViewLabel(java.lang.String name,
                             java.lang.String description,
                             DateTime time,
                             boolean buildLabel,
                             boolean frozen)

Create a new "View" label with the specified properties. This method creates the label on the server so a call to update() is not needed. Use a DateTime created with the special value 0.0 to create the label as of the current server time.

Parameters:

name - the label name (may not be null)

description - the label description (may not be null)

time - the view configuration time (may not be null)

buildLabel - true if the label is to be a "Build Label"

frozen - true if the label is "frozen" (a frozen label can not be moved from one revision to another)

Returns:

created view label

createRevisionLabel

public Label createRevisionLabel(java.lang.String name,
                                 java.lang.String description,
                                 boolean frozen)

Create a new "Revision" label with the specified properties. This method creates the label on the server so a call to update() is not needed.

Parameters:

name - the label name (may not be null)

description - the label description (may not be null)

frozen - true if the label is "frozen" (a frozen label can not be moved from one revision to another)

Returns:

created revision label

cloneViewLabel

public Label cloneViewLabel(Label source,
                            java.lang.String name,
                            java.lang.String description,
                            boolean buildLabel,
                            boolean frozen)

Clones the specified "View" label. This method creates the label on the server so a call to update() is not needed.

Parameters:

source - the label to be cloned (it must be from the active view)

name - the label name (may not be null)

description - the label description (may not be null)

buildLabel - true if the label is to be a "Build Label"

frozen - true if the label is "frozen" (a frozen label can not be moved from one revision to another)

Returns:

clone of this view label

cloneRevisionLabel

public Label cloneRevisionLabel(Label source,
                                java.lang.String name,
                                java.lang.String description,
                                boolean frozen)

Clones the specified "Revision" label. This method creates the label on the server so a call to update() is not needed.

Parameters:

source - the label to be cloned (it must be from the active view)

name - the label name (may not be null)

description - the label description (may not be null)

frozen - true if the label is "frozen" (a frozen label can not be moved from one revision to another)

Returns:

clone of this revision label

getPromotionModel

public PromotionModel getPromotionModel()

Returns the promotion model associated with this view.

Returns:

the promotion model associated with this view.

getDefaultPath

public java.lang.String getDefaultPath()

Returns the default working file path to be used for this view. This is the value stored in the repository.

Returns:

the default working file path to be used for this view.

setDefaultPath

public void setDefaultPath(java.lang.String path)

Sets the default working file path to be used for this view. This is the value stored in the repository.

Parameters:

path - the new default path

getAlternatePath

public java.lang.String getAlternatePath()

Returns the alternate working file path to be used for this view. This is the value stored client-side as an override to the default path.

Returns:

the alternate working file path to be used for this view.

setAlternatePath

public void setAlternatePath(java.lang.String path)

Sets the alternate working file path to be used for this view. This is the value stored client-side as an override to the default path.

Parameters:

path - the new alternate path

setStatusMethodOverride

public void setStatusMethodOverride(StatusMethod method)

Changes the status method to use for files in this view. This is a client side setting and will not change the behavior for other users of this view.

Parameters:

method - the new status method to use, may not be null.

getStatusMethodOverride

public StatusMethod getStatusMethodOverride()

Returns the status method used to determine status for files in this view. This method will not return null.

getFileStatusManager

public FileBasedStatusManager getFileStatusManager()

Get the FileBasedStatusManager that manages file status information for this View. The corresponding StarTeam Server must support client-managed status.

Returns:

The FileBasedStatusManager for this View.

See Also:

StatusMethod.getStatusManager(View)

getPath

public java.lang.String getPath()

Returns the working file path being used for this view. This path is either the default path or the alternate path. A non-null alternate path takes precedence over a default path.

Returns:

the working file path being used for this view.

getRootFolder

public Folder getRootFolder()

Gets the root folder of this view. The Folder hierarchy is cached in the View object, until explicitly refreshed or discarded.

Returns:

The root folder of this view.

See Also:

View.refreshFolders(), View.discardFolders()

getConfiguration

public ViewConfiguration getConfiguration()

Returns this view's configuration.

Returns:

this view's configuration.

getBaseConfiguration

public ViewConfiguration getBaseConfiguration()

Returns the ViewConfiguration from which this View was derived.

Returns:

the ViewConfiguration from which this View was derived.

See Also:

ViewConfiguration

getCreatedTime

public DateTime getCreatedTime()

Returns the time at which the view was created.

Overrides:

getCreatedTime in class LiveObject

Returns:

the time at which the view was created.

getDescription

public java.lang.String getDescription()

Returns the description of this view.

Returns:

the description of this view.

setDescription

public void setDescription(java.lang.String description)

Sets the description for this view.

Parameters:

description - the description for this view

setViewType

public void setViewType(View.ViewType type)

Sets the type of this View. This property is new to 12.0+ servers Supported values include Main, Sandbox, Release and unknown.

Parameters:

type - The new type value for this view

getViewType

public View.ViewType getViewType()

Gets the type (Unknown, Main, Sandbox, Release) of this View. This property is new to 12.0+ servers

Returns:

type (Unknown, Main, Sandbox, Release) of this View

See Also:

View.ViewType, View.Type.TypeProperty, View.Type.PropertyCollection.TYPE

setStartDate

public void setStartDate(DateTime startDate)

Sets the start date of this view. This property is available starting from the 12.5 release of the Starteam server.

Parameters:

startDate - start date for this view.

See Also:

View.Type.StartDateProperty

getStartDate

public DateTime getStartDate()

Gets the start date of this view. This property is available starting from the 12.5 release of the Starteam server.

Returns:

start date of this View

See Also:

View.Type.StartDateProperty

setEndDate

public void setEndDate(DateTime endDate)

Sets the end date of this view. This property is available starting from the 12.5 release of the Starteam server.

Parameters:

endDate - end date for this view

See Also:

View.Type.EndDateProperty

getEndDate

public DateTime getEndDate()

Gets the end date of this view. This property is available starting from the 12.5 release of the Starteam server.

Returns:

end date of this View

See Also:

View.Type.EndDateProperty

getFullName

public java.lang.String getFullName()

Returns the full hierarchical name of this view--that is, the concatenation of the root view and each descendant to this view.

Returns:

the full hierarchical name of this view.

getServer

public Server getServer()

Returns the server to which this view belongs.

Specified by:

getServer in interface ISecurable

Specified by:

getServer in interface ISecurableContainer

Overrides:

getServer in class TypedResource

Returns:

the server to which this view belongs.

getName

public java.lang.String getName()

Returns the name of this view.

Returns:

the name of this view.

setName

public void setName(java.lang.String name)

Set the name of this view.

Parameters:

name - - the name of this view.

getProject

public Project getProject()

Returns the project to which this view belongs.

Returns:

the project to which this view belongs.

getParentView

public View getParentView()

Returns the parent of this view.

Returns:

the parent of this view, or null if there is no parent.

getDerivedViews

public View[] getDerivedViews()

Returns the set of views derived from this one.

Returns:

The set of views derived from this one. Returns an empty array if there are no derived views.

findDerivedView

public View findDerivedView(java.lang.String name)

Return an immediate derived view with the specified name or NULL if none exist

Parameters:

name - the name of an immediate derived view

Returns:

an immediate derived view with the specified name

createCheckinManager

public CheckinManager createCheckinManager()

Constructs a CheckinManager with default options for this view.

Returns:

CheckinManager created

createCheckinManager

public CheckinManager createCheckinManager(CheckinOptions options)

Constructs a CheckinManager using a specific set of options.

Note that individual options can be overridden on a file-by-file basis by registering a CheckinListener, and changing options as necessary in the onStartFile event handler.

Parameters:

options - The specific CheckinOptions to be used.

Returns:

CheckinManager created

See Also:

CheckinOptions, CheckinManager.addCheckinListener(com.starteam.events.CheckinListener), CheckinManager.onStartFile(com.starteam.events.CheckinListener, com.starteam.events.CheckinEvent)

createCheckoutManager

public CheckoutManager createCheckoutManager()

Constructs a CheckoutManager with default options for this view.

Returns:

CheckoutManager created

createCheckoutManager

public CheckoutManager createCheckoutManager(CheckoutOptions options)

Constructs a CheckoutManager using a specific set of options.

Note that individual options can be overridden on a file-by-file basis by registering a CheckoutListener, and changing options as necessary in the onStartFile event handler.

Parameters:

options - The specific CheckoutOtions to be used.

Returns:

CheckoutManager created

See Also:

CheckoutOptions, CheckoutManager.addCheckoutListener(com.starteam.events.CheckoutListener), CheckoutManager.onStartFile(CheckoutListener, CheckoutEvent)

hasPermissions

public boolean hasPermissions(PermissionCollection permissions)

Returns true if desired permissions are granted for this view

Specified by:

hasPermissions in interface ISecurable

Parameters:

permissions - the desired permissions

Returns:

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

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 view

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

getRights

public ACE[] getRights()

Returns the Access Control List for this view. From 12.0 release of the server onwards, MPX events are sent by the server upon ACL updates. So, the server calls are optimized when mpx is enabled. For servers prior to 12.0 release, The access control list is not cached, and will be fetched from the server on demand. Cached lists are accessible via the AccessRightsManager

Specified by:

getRights in interface ISecurable

Returns:

the access control list for this view or NULL.

See Also:

AccessRightsManager.getRights(com.starteam.ISecurable)

setRights

public void setRights(ACE[] acl)

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

Specified by:

setRights in interface ISecurable

Parameters:

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

See Also:

ACE

getRights

public ACE[] getRights(Type type)

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

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 view 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 view. If the ACL is null then the access control list for items of the specified type will be dropped.

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

findFolder

public Folder findFolder(int itemID)

Returns a Folder in the View, given its Item ID, or NULL if none found.

Parameters:

itemID - the Item ID of the Folder to be retrieved.

Returns:

a Folder in the View, given its Item ID, or NULL if none found.

findItem

public Item findItem(Item.Type type,
                     int itemID)

Returns an Item in the View, given its Type and Item ID, or NULL if none found.

Parameters:

type - the Type of the Item to be retrieved.

itemID - the Item ID of the Item to be retrieved.

Returns:

an Item in the View, given its Type and Item ID, or NULL if none found.

findViewMember

public ViewMember findViewMember(ViewMember.Type type,
                                 int VMID)

Returns a ViewMember in the View, given its Type and VMID, or NULL if none found.

Parameters:

type - the Type of the ViewMember to be retrieved.

VMID - the VMID of the ViewMember to be retrieved.

Returns:

a ViewMember in the View, given its Type and VMID, or NULL if none found.

remove

public void remove()

Removes the view from the server.

isDeleted

public boolean isDeleted()

Determines whether or not this view has been deleted from the server.

Specified by:

isDeleted in interface ISecurable

Specified by:

isDeleted in interface ISecurableContainer

Returns:

True if the view has been deleted from the server; false otherwise.

discard

public void discard()

Discards all of the cached properties for this view. They will be re-fetched from the server on demand (even when MPX is enabled).

If the properties of a view are changed, and discard() is called without first calling update(), the changes will be lost.

See Also:

View.refresh()

update

public void update()

Persists this view's properties to its Server.

discardLabels

public void discardLabels()

Discards cached Label information. The next call to getLabels() will re-fetch the label information from the StarTeam Server (even when MPX is enabled).

See Also:

View.getLabels(), View.refreshLabels()

isRefreshLabelsRequired

public boolean isRefreshLabelsRequired()

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

Returns:

true if label information may be out of date.

See Also:

View.refreshLabels(), Server.enableMPX()

refreshLabels

public void refreshLabels()

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

See Also:

View.isRefreshLabelsRequired(), View.getLabels(), View.discardLabels(), Server.enableMPX()

refreshPromotionModel

public void refreshPromotionModel()

Refreshes the local cached information about this view's promotion model.

refreshFolders

public void refreshFolders()

Updates cached Folder information to reflect recent changes to the server. Existing Folder objects are modified in place whenever possible.

If MPX is enabled, refreshFolders() is optimized to avoid unnecessary server commands.

In all cases, refreshFolders() has the side effect of clearing any Item lists that have already been populated. Thus, the next attempt to retrieve the Items will return an up-to-date list consisting of newly allocated Item objects. If MPX is enabled, the process of re-populating the Item lists is optimized to avoid unnecessary server commands.

See Also:

View.isRefreshFoldersRequired(), View.getRootFolder(), View.discardFolders(), Server.enableMPX()

isRefreshFoldersRequired

public boolean isRefreshFoldersRequired()

Returns true if a View.refreshFolders() operation might have resulted in Folder information being updated; returns false if and only if it is known that the folders had not been changed since the last refresh. If MPX is not enabled, then isRefreshFoldersRequired() always returns true.

Returns:

true if folder information may be out of date.

See Also:

View.refreshFolders(), Server.enableMPX()

discardFolders

public void discardFolders()

Discards all cached Folder information. It will be re-fetched from the server on demand (even when MPX is enabled).

See Also:

View.getRootFolder(), View.refreshFolders()

resolveLinkEndpoint

public Item resolveLinkEndpoint(Link.Endpoint endpoint)

Returns the item in this view referred to by the LinkEndpoint. If the reference is pinned to a historical (non-tip) version, that version is returned from the history of the tip item in this view.

Parameters:

endpoint - the endpoint to be resolved

Returns:

the item referred to by the LinkEndpoint or null if the reference does not refer to a valid item in this view.

getDisembodiedViewMember

public ViewMember getDisembodiedViewMember(ViewMember.Type type,
                                           int vmID)

Retrieves a ViewMember by VMID. The ViewMember can reside anywhere in this view, or in any other view on the same server. However, the resulting ViewMember is "disembodied"; that is, it is not attached to its normal context. Disembodied ViewMembers are useful for resolving LinkEndpoints, which can cross project and view boundaries. However, many normal ViewMember operations are not supported for disembodied ViewMembers. getDisembodiedViewMember() is not MPX-enabled; each call to getDisembodiedViewMember() retrieves data directly from the server.

Parameters:

type - the type of the disembodied view member

vmID - the id of the disembodied view member

Returns:

a disembodied view member

See Also:

ViewMember.isDisembodied()

getDisembodiedItem

public Item getDisembodiedItem(Item.Type type,
                               int itemID)

Retrieves an Item by Item ID. The Item can reside anywhere in this view, or in any other view on the same server. However, the resulting Item is "disembodied"; that is, it is not attached to its normal parent Folder. Disembodied Items are useful for resolving LinkEndpoints, which can cross project and view boundaries. However, many normal Item operations are not supported for disembodied items. getDisembodiedItem() is not MPX-enabled; each call to getDisembodiedItem() retrieves data directly from the server.

Parameters:

type - the type of disembodied item

itemID - the id of the disembodied item

Returns:

a disembodied item

See Also:

ViewMember.isDisembodied()

getChangePackages

public ChangePackageCollection getChangePackages()

Gets the change packages contained in this view.

Note that the resulting collection is a read-only collection; that is, you cannot explicitly add or remove members. Instead, the members reflect the actual set of change packages available for this view on the server. Members may come and go as a side effect of refreshing the collection.

Returns:

ChangePackageCollection

Throws:

TypeNotFoundException - if change packages are not supported by this version of the StarTeam server.

See Also:

View.getViewMembers(com.starteam.ViewMember.Type), ChangePackageCollection.getCache()

getTraces

public TraceCollection getTraces()

Gets the traces which exists in this view.

Note that the resulting collection is a read-only collection; that is, you cannot explicitly add or remove members. Instead, the members reflect the actual set of traces available for this view on the server. Members may come and go as a side effect of refreshing the collection.

Returns:

TraceCollection

See Also:

ViewMemberCollection.getCache()

getViewMembers

public ViewMemberCollection getViewMembers(ViewMember.Type type)

Gets the view members of the given type contained in this view.

Note that the resulting collection is a read-only collection; that is, you cannot explicitly add or remove members. Instead, the members reflect the actual set of view members of this type available for this view on the server. Members may come and go as a side effect of refreshing the collection.

Parameters:

type - the type of the view members in the returned collection

Returns:

ViewMemberCollection

Throws:

java.lang.UnsupportedOperationException - if the given type is not a view member type.

See Also:

View.getViewMembers(com.starteam.ViewMember.Type), ChangePackageCollection.getCache()

getWorkflow

public Workflow getWorkflow(ViewMember.Type typ)

Returns the type specific workflow definition for this view, if any If a workflow has not been defined for the view, but a project wide workflow has been defined for the type, the project workflow is returned If a project wide workflow has not been defined then the server wide workflow for the type is returned.

Parameters:

typ - the type for which a specific workflow may have been defined

Returns:

the type specific workflow definition for this view or NULL

equals

public boolean equals(java.lang.Object another)

Returns true if the specified object identifies the same view as this one.

Overrides:

equals in class java.lang.Object

Parameters:

another - the object being tested for equality

Returns:

true if the specified object identifies that same view as this one

hashCode

public int hashCode()

Returns a hash code for this view.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this view.

hasNewNotificationItems

public boolean hasNewNotificationItems(Item.Type type)

Return true if any new notification items are available in this view for the specified item type.

Parameters:

type - the desired item type

Returns:

true if any new notification items are available in this view

getNewNotificationItems

public ViewMemberCollection getNewNotificationItems(Item.Type type)

Return the list of "notification" items for the specified type. This method will not return null but may return an empty list. Once this call has been made to the server for a particular view subsequent calls will not return the same information. The act of getting the information "clears" it from the server.

Parameters:

type - the desired item type

Returns:

the list of "notification" items for the logged in user.

toString

public java.lang.String toString()

Returns the name of this view.

Overrides:

toString in class TypedResource

Returns:

the name of this view.

close

public void close()

Frees all cached resources associated with this view, and closes the associated view session.

Many view-related resources, such as the folder tree, item lists and so on, can be discarded separately. Others, however, are freed only by an explicit call to close().

After a view is closed, the view object is still useful. The view session is automatically re-opened when needed, and data is re-fetched from the server on demand.

See Also:

View.discard(), View.discardFolders(), View.discardLabels(), Folder.discardItems(com.starteam.Item.Type, int), Server.disconnect()

getRecycleBin

public RecycleBin getRecycleBin()

Provides access to the items that have been deleted from a view.

For example:

 RecycleBin bin = view.getRecycleBin();
 Folder root = bin.getRootFolder();
 Item[] files = root.getItems(File.Type.NAME);
 for (int i = 0; i < files.length; i++) {
        assertTrue(files[i].isDeleted());
 }
 

Note that this method is supported by StarTeam Server versions 9.0 and later.

Returns:

The recycle bin associated with this view.

See Also:

RecycleBin

addViewListener

public void addViewListener(ViewListener listener)

Adds a listener for View events.

Event handlers will be triggered when this View is changed or deleted.

In order to handle events, an application must enable MPX. The logged-in user must have access permissions for this View.

Parameters:

listener - Application-specific event handler for View events.

See Also:

ViewListener, View.removeViewListener(com.starteam.events.ViewListener), Server.enableMPX()

removeViewListener

public void removeViewListener(ViewListener listener)

Removes a listener for View events.

Parameters:

listener - Previously-registered event handler for View events.

See Also:

ViewListener, View.addViewListener(com.starteam.events.ViewListener)

addLabelListener

public void addLabelListener(LabelListener listener)

Adds a listener for Label events.

Event handlers will be triggered whenever a Label is added, changed, or deleted in this View.

In order to handle events, an application must enable MPX. The logged-in user must have access permissions for this View.

Parameters:

listener - Application-specific event handler for Label events.

See Also:

LabelListener, View.removeLabelListener(com.starteam.events.LabelListener), Server.enableMPX()

removeLabelListener

public void removeLabelListener(LabelListener listener)

Removes a listener for Label events.

Parameters:

listener - Previously-registered event handler for Label events.

See Also:

LabelListener, View.addLabelListener(com.starteam.events.LabelListener)

addFolderListener

public void addFolderListener(IFolderListener listener)

Adds a listener for Folder-related events.

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

Parameters:

listener - Application-specific event handler for Folder-related events. Any class that implements the FolderListener or FolderTreeListener interface (or both) is supported.

See Also:

IFolderListener, FolderListener, FolderTreeListener, View.removeFolderListener(com.starteam.events.IFolderListener), Server.enableMPX()

removeFolderListener

public void removeFolderListener(IFolderListener listener)

Removes a listener for Folder-related events.

Parameters:

listener - Previously-registered event handlers for Folder-related events.

See Also:

IFolderListener, View.addFolderListener(com.starteam.events.IFolderListener)

addFolderUpdateListener

public void addFolderUpdateListener(FolderUpdateListener listener)

Listens for updates to this view's folder tree.

Similar to addFolderListener(), except that events are triggered by explicit operations performed by the client application. For example, calling View.refreshFolders(), Folder.update() or Folder.remove() might each trigger update events.

MPX is not required to receive folder update events.

Parameters:

listener - Application-specific event handler for folder update events.

See Also:

FolderUpdateListener, View.removeFolderUpdateListener(com.starteam.events.FolderUpdateListener), View.addFolderListener(com.starteam.events.IFolderListener)

removeFolderUpdateListener

public void removeFolderUpdateListener(FolderUpdateListener listener)

Removes a listener for folder update events.

Parameters:

listener - Previously-registered event handler for folder update events.

See Also:

FolderUpdateListener, View.addFolderUpdateListener(com.starteam.events.FolderUpdateListener)

addViewMemberListener

public void addViewMemberListener(ViewMemberListener listener,
                                  ViewMember.Type type)

Adds a listener for non-Item ViewMember-related events.

ViewMember objects passed to application event handlers may not have fully-populated properties. The only properties that are guaranteed to be populated in all cases are the descriptors.

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

Parameters:

listener - Application-specific event handler for non-Item ViewMember-related events.

type - The Type of the viewMembers of interest.

See Also:

ViewMemberListener, View.addViewMemberListener(ViewMemberListener,ViewMember.Type,PropertyCollection), View.removeViewMemberListener(com.starteam.events.ViewMemberListener, com.starteam.ViewMember.Type), Server.enableMPX()

addViewMemberListener

public void addViewMemberListener(ViewMemberListener listener,
                                  ViewMember.Type type,
                                  PropertyCollection properties)

Adds a listener for non-Item ViewMember-related events.

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

Parameters:

listener - Application-specific event handler for non-Item ViewMember-related events.

type - The Type of the viewMembers of interest.

properties - properties that must always be populated whenever a ViewMember object is passed to an application event-handler.

See Also:

ViewMemberListener, View.addViewMemberListener(ViewMemberListener,ViewMember.Type), View.removeViewMemberListener(com.starteam.events.ViewMemberListener, com.starteam.ViewMember.Type), Server.enableMPX()

removeViewMemberListener

public void removeViewMemberListener(ViewMemberListener listener,
                                     ViewMember.Type type)

Removes a listener for non-Item ViewMember-related events.

Parameters:

listener - Previously registered event handlers for non-Item ViewMember-related events.

type - The Type of the viewMembers of interest.

See Also:

ViewMemberListener, View.addViewMemberListener(com.starteam.events.ViewMemberListener, com.starteam.ViewMember.Type)

addItemListener

public void addItemListener(IItemListener listener,
                            Item.Type type)

Adds a listener for Item-related events.

If listener is an ItemListener, then Item objects passed to application event handlers may not have fully-populated properties. The only properties that are guaranteed to be populated in all cases are the Item's descriptors.

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

Parameters:

listener - Application-specific event handler for Item-related events. Any class that implements one (or more) of the IItemListener interfaces is supported.

type - The Type of the items of interest.

See Also:

IItemListener, ItemListener, ItemIDListener, ItemListListener, NotificationListener, View.addItemListener(IItemListener,Item.Type,PropertyCollection), View.removeItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type), Server.enableMPX()

addItemListener

public void addItemListener(IItemListener listener,
                            Item.Type type,
                            PropertyCollection properties)

Adds a listener for Item-related events.

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

Parameters:

listener - Application-specific event handler for Item-related events. Any class that implements one (or more) of the IItemListener interfaces is supported.

type - The Type of the items of interest.

properties - properties that must always be populated whenever an Item object is passed to an application event-handler. Relevant only when listener is an ItemListener.

See Also:

IItemListener, ItemListener, ItemIDListener, ItemListListener, NotificationListener, View.addItemListener(IItemListener,Item.Type), View.removeItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type), Server.enableMPX()

removeItemListener

public void removeItemListener(IItemListener listener,
                               Item.Type type)

Removes a listener for Item-related events.

Parameters:

listener - Previously-registered event handlers for Item-related events.

type - The Type of the items of interest.

See Also:

IItemListener, View.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type)

addItemUpdateListener

public void addItemUpdateListener(ItemUpdateListener listener,
                                  Item.Type type)

Listens for updates to the items of a given type in this view.

Similar to addItemListener(), except that events are triggered by explicit operations performed by the client application. For example, calling File.refreshItems(), Item.update() or Item.remove() might each trigger update events.

MPX is not required to receive item update events. Applications intending to receive Folder update events must use View.addFolderUpdateListener(FolderUpdateListener)

Parameters:

listener - Application-specific event handler for item update events.

type - The Type of the items of interest.

See Also:

ItemUpdateListener, View.removeItemUpdateListener(com.starteam.events.ItemUpdateListener, com.starteam.Item.Type), View.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type)

addViewMemberUpdateListener

public void addViewMemberUpdateListener(ViewMemberUpdateListener listener,
                                        ViewMember.Type type)

Listens for updates to the view members of a given type in this view.

Events are triggered by explicit operations performed by the client application. For example, calling Trace.update(), or Trace.remove() might each trigger update events.

MPX is not required to receive view member update events. Applications intending to receive Item update events must use View.addItemUpdateListener(ItemUpdateListener, Item.Type)

Parameters:

listener - Application-specific event handler for view member update events.

type - The Type of the view members of interest.

See Also:

ViewMemberUpdateListener, View.removeViewMemberUpdateListener(com.starteam.events.ViewMemberUpdateListener, com.starteam.ViewMember.Type)

removeViewMemberUpdateListener

public void removeViewMemberUpdateListener(ViewMemberUpdateListener listener,
                                           ViewMember.Type type)

Removes a listener for view member update events.

Parameters:

listener - Previously-registered event handler for view member update events.

type - The Type of the view members of interest.

See Also:

ViewMemberUpdateListener, View.addViewMemberUpdateListener(com.starteam.events.ViewMemberUpdateListener, com.starteam.ViewMember.Type)

removeItemUpdateListener

public void removeItemUpdateListener(ItemUpdateListener listener,
                                     Item.Type type)

Removes a listener for item update events.

Parameters:

listener - Previously-registered event handler for item update events.

type - The Type of the items of interest.

See Also:

ItemUpdateListener, View.addItemUpdateListener(com.starteam.events.ItemUpdateListener, com.starteam.Item.Type)

getParentContainer

public ISecurableContainer getParentContainer()

If there are no access rights explicitly assigned to this object, then the effective access rights come from a parent container.

Specified by:

getParentContainer in interface ISecurable

Specified by:

getParentContainer in interface ISecurableContainer

Returns:

This object's parent container.

See Also:

ISecurableContainer