com.starteam
Class RecycleBin

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

All Implemented Interfaces:

ISecurable, ISecurableContainer, java.lang.Cloneable

public class RecycleBin
extends View

Provides access to the items that have been deleted from a view. The RecycleBin has properties that may be used to control which items are included. For example, IncludeDeletedFolders determines whether or not deleted folders are included in the folder tree. IncludeActiveItems determines whether or not active items are included along with deleted ones. Note that the recycle bin for a View with a rolled back ViewConfiguration (that is, a configuration other than the tip) reflects the state of deleted items as of the configuration time. If an item was active at the configuration time and deleted afterwards, it does not appear deleted in the recycle bin.

See Also:

View.getRecycleBin(), ViewMember.isDeleted()

Nested Class Summary

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

View.Type, View.ViewType, View.WebCacheView

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

LiveObject.WebCacheLiveObject

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

TypedResource.BranchState

Method Summary

void	close() Frees all cached resources associated with this view, and closes the associated view session.
DateTime	getDeletedAsOf() Used to limit deleted folders and items to those that were after a given time.
boolean	getIncludeActiveItems() Determines whether or not the resulting folders may contain active items.
boolean	getIncludeDeletedFolders() Determines whether or not deleted child folders will be inserted into the copy of the folder tree.
boolean	getIncludeDeletedItems() Determines whether or not the resulting folders may contain deleted items.
boolean	isRefreshFoldersRequired() Returns true if a 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.
void	setDeletedAsOf(DateTime deletedAsOf) Used to limit deleted folders and items to those that were after a given time.
void	setIncludeActiveItems(boolean isIncluded) Sets whether or not the resulting folders may contain active items.
void	setIncludeDeletedFolders(boolean isIncluded) Sets whether or not deleted folders will be inserted into the copy of the folder tree.
void	setIncludeDeletedItems(boolean isIncluded) Sets whether or not the resulting folders may contain deleted items.

Methods inherited from class com.starteam.View

addFolderListener, addFolderUpdateListener, addItemListener, addItemListener, addItemUpdateListener, addLabelListener, addViewListener, addViewMemberListener, addViewMemberListener, addViewMemberUpdateListener, cloneRevisionLabel, cloneViewLabel, copy, createCheckinManager, createCheckinManager, createCheckoutManager, createCheckoutManager, createChildViewShareAllItems, createChildViewShareDefaultItems, createChildViewShareNoItems, createChildViewShareTheseItems, createRevisionLabel, createViewLabel, discard, discardActiveLabels, discardFolders, discardLabels, equals, fetchAllLabels, fetchAllLabels, findDerivedView, findFolder, findItem, findLabel, findLabel, findViewMember, getActiveLabels, getAlternatePath, getBaseConfiguration, getChangePackages, getConfiguration, getCreatedTime, getDefaultPath, getDerivedViews, getDescription, getDisembodiedItem, getDisembodiedViewMember, getEndDate, getFileStatusManager, getFullName, getID, getLabels, getName, getNewNotificationItems, getParentContainer, getParentView, getPath, getPresentationID, getProject, getPromotionModel, getProperties, getRecycleBin, getRights, getRights, getRootFolder, getServer, getStartDate, getStatusMethodOverride, getTraces, getValue, getViewID, getViewMembers, getViewType, getWorkflow, hashCode, hasNewNotificationItems, hasPermissions, hasPermissions, isAccessible, isBranch, isBranchAll, isBranchNone, isBranchOnShare, isDeleted, isEqualTo, isNonDerived, isReadOnly, isReference, isRefreshActiveLabelsRequired, isRefreshLabelsRequired, isRefreshRequired, isRoot, populate, refresh, refreshActiveLabels, refreshFolders, refreshLabels, refreshPromotionModel, remove, removeFolderListener, removeFolderUpdateListener, removeItemListener, removeItemUpdateListener, removeLabelListener, removeViewListener, removeViewMemberListener, removeViewMemberUpdateListener, resolveLinkEndpoint, setAlternatePath, setBranchOnShare, setDefaultPath, setDescription, setEndDate, setName, setRights, setRights, setStartDate, setStatusMethodOverride, setValue, setViewType, toString, update

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

Method Detail

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(), or to Server.disconnect().

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.

Overrides:

close in class View

See Also:

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

getIncludeDeletedFolders

public boolean getIncludeDeletedFolders()

Determines whether or not deleted child folders will be inserted into the copy of the folder tree.

Returns:

true if deleted folders are included in the folder tree; false if only active folders are included. Default value is true.

setIncludeDeletedFolders

public void setIncludeDeletedFolders(boolean isIncluded)

Sets whether or not deleted folders will be inserted into the copy of the folder tree.

Parameters:

isIncluded - true to include deleted folders in the folder tree; false to include only active folders. Default value is true.

getIncludeDeletedItems

public boolean getIncludeDeletedItems()

Determines whether or not the resulting folders may contain deleted items.

Returns:

true if the resulting folders may contain deleted items; false if they may contain only active items. Default value is true. At least one of IncludeDeletedItems and IncludeActiveItems is always set.

setIncludeDeletedItems

public void setIncludeDeletedItems(boolean isIncluded)

Sets whether or not the resulting folders may contain deleted items.

Parameters:

isIncluded - if the resulting folders may contain deleted items; false if they may contain only active items. Default value is true. At least one of IncludeDeletedItems and IncludeActiveItems is always set.

getIncludeActiveItems

public boolean getIncludeActiveItems()

Determines whether or not the resulting folders may contain active items.

Returns:

true if the resulting folders may contain active items; false if they may contain only deleted items. Default value is false. At least one of IncludeDeletedItems and IncludeActiveItems is always set.

setIncludeActiveItems

public void setIncludeActiveItems(boolean isIncluded)

Sets whether or not the resulting folders may contain active items.

Parameters:

isIncluded - if the resulting folders may contain active items; false if they may contain only deleted items. Default value is false. At least one of IncludeDeletedItems and IncludeActiveItems is always set.

getDeletedAsOf

public DateTime getDeletedAsOf()

Used to limit deleted folders and items to those that were after a given time.

Returns:

The deletion time. Only folders and/or item deleted after this time are included. Default value is null, indicating that all deleted folders and/or items are included.

setDeletedAsOf

public void setDeletedAsOf(DateTime deletedAsOf)

Used to limit deleted folders and items to those that were after a given time.

Parameters:

deletedAsOf - The deletion time. Only folders and/or item deleted after this time are included. Default value is null, indicating that all deleted folders and/or items are included.

isRefreshFoldersRequired

public boolean isRefreshFoldersRequired()

Returns true if a 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.

Overrides:

isRefreshFoldersRequired in class View

Returns:

true if folder information may be out of date.

See Also:

RecycleBin.setIncludeDeletedFolders(boolean), RecycleBin.setDeletedAsOf(com.starteam.util.DateTime), View.isRefreshFoldersRequired()