Package com.starbase.starteam

Interface Summary
CacheAgentListener Event-listener interface for CacheAgent events.
CheckinListener Event-listener interface for checkout events.
CheckoutListener Event-listener interface for checkout events.
ContentFilter Allows an application to hook into the checkout process at a low level.
FileDigest The FileDigest interface specifies the nescessary information to determine if a file on disk has changed from some checkpoint.
FileSyncInfo The FileSyncInfo interface specifies the pairing of the two important pieces of information needed to know what is on a user's local disk: RevisionIdentifier and FileDigest.
FilterListener Event-listener interface for Filter events.
FolderListener Event-listener interface for Folder events.
FolderTreeListener FolderTreeListener allows an application to listen for changes to the structure of the folder tree.
FolderUpdateListener Event-listener interface for Folder update events.
HiveInfo.HiveType Constants identifying the type of archive files stored in a vault hive.
IFilterQueryListener Event-listener interface for Filter and/or Query events.
IFolderListener Event-listener interface for Folder events.
IItemListener Event-listener interface for Item events.
ISecurable An object that can be secured in the repository.
ISecurableContainer A container in the repository that can hold secured objects of a given type.
ISecurableObject An object that can be secured in the repository.
Item.LockType Defines the constants representing the valid lock operations on items.
ItemIDListener Event-listener interface for ItemID events.
ItemListener Event-listener interface for Item events.
ItemListListener ItemListListener allows an application to listen for changes to the contents of one or more folders.
Items Describes a virtual array of Items, and methods for accessing them.
ItemUpdateListener Event-listener interface for Item update events.
Keyword A Keyword object that encapsulates information about a File keyword.
LabelListener Event-listener interface for Label events.
LinkUpdateListener Event-listener interface for Link update events.
MPXStatusListener Event-listener interface for MPXStatusEvents.
NotificationListener NotificationListener allows an application to listen for "notification" items for the logged-in user.
Permission This interface contains fields defining all the different permission settings used by StarTeam.
ProjectListener Event-listener interface for Project events.
Property.Types Constants identifying the value type of a property.
QueryListener Event-listener interface for Query events.
RevisionIdentifier The RevisionIdentifier interface globally and uniquely identifies a specific revision of a StarTeam object.
SecurityLogEntry.SecurityEventType Constants that define the type of the Security Event.
ServerControlListener Event-listener interface for ServerControl events.
ServerSession Represents a user's session with the server.
TypeListener Event-listener interface for Type events.
UserListener Event-listener interface for User events.
ViewListener Event-listener interface for View events.
 

Class Summary
_PrivateMethods_ Title: Starbase SDK
AccessCheckSecLogID For Access Check events.
AccessRightsManager Provides utilities for manipulating access rights.
AccessTestResults Represents the results of an access test.
AclEntry An Access Control List entry.
AddResult The class holds return information specific to the file add operation.
Audit Represents a StarTeam Audit record
BLSLicenseInfo A license managed by the Borland License Server.
BuildNumber A simple class that provides access to version information for the StarTeam SDK.
CacheAgent Describes the features of a Cache Agent, including the type of content it caches, the projects supported, and whether or not it caches file content.
CacheAgentAdapter A stub implementation of the CacheAgentListener interface.
CacheAgentEvent An event triggered whenever content is received from a CacheAgent.
CacheController For each repository accessed via some Server object, we maintain a local cache that holds data fetched from the repository.
CacheRef For internal use only.
Catalog The Catalog class provides "global" access to certain properties of objects from different classes.
ChangeRequest Represents a StarTeam ChangeRequest item.
CheckinEvent An event triggered whenever a file is checked in through CheckinManager.
CheckinManager Provides a way to check out multiple files, applying a consistent set of options across all files.
CheckinOptions Maintains the checkout options used by CheckinManager.
CheckinPhase Information on the phase of a checkin progress of the checkin operation from CheckinManager.
CheckinProgress Information on the progress of a checkin operation from CheckinManager.
CheckInResult The class holds return information specific to the file checkin operation.
CheckoutEvent An event triggered whenever a file is checked out through CheckoutManager.
CheckoutManager Provides a way to check out multiple files, applying a consistent set of options across all files.
CheckoutOptions Maintains the checkout options used by CheckoutManager.
CheckoutProgress Information on the progress of a checkout operation from CheckoutManager.
CheckOutResult The class holds return information specific to the file checkout operation.
ClientApplication Manages information about the client application.
ClientContext The ClientContext class contains the nescessary information in order to run the SDK on one machine for a client running on a different machine.
ColumnInfo  
ConfigFiles All client stored config file locations for StarTeam can be found using this class.
ContainerACLSecLogID For Container-level security log events.
DirectoryOverrides A class that can parse a StarTeam.ini file and work with the view and folder overrides it specifies.
EffectiveACE An Access Control Entry (ACE) in an Effective Access Control List (ACL).
EmailAttachment This class embodies an email attachment.
EnumeratedValue A simple integer/String pair object to be used for adding new custom enumerated fields (Property) and modifying existing enumerated fields (Property).
EventHandlerInfo The EventHandlerInfo class describes a registered event handler, such as the one for the StarTeam MPX Server.
EventHandlerProfile The EventHandlerProfile class contains the information of one of profiles of an EventHandlerInfo.
File Represents a StarTeam File item.
FileBasedStatusManager Manages File Status information on the local client workstation.
FileResult The class holds return information common to the file operations of add, checkin and checkout.
FileStream Provides utility function for manipulating File streams.
Filter The Filter class is used to define criteria for which items (files, change requests) should be displayed to a user.
FilterAdapter A stub implementation of the FilterListener interface.
FilterEvent An event triggered whenever a Filter is added, changed or deleted on the server.
FilterQueryAdapter A stub implementation of the FilterListener and QueryListener interfaces.
Folder Represents a StarTeam Folder.
FolderAdapter A stub implementation of the FolderListener interface.
FolderEvent An event triggered whenever a Folder is added, moved, changed or deleted in a View.
FolderListManager Manages a collection of folders created by including and excluding selected folders and their subfolders.
FolderTreeAdapter A stub implementation of the FolderTreeListener interface.
FolderTreeEvent An event triggered whenever the Folder hierarchy is changed in a View.
FolderUpdateAdapter A stub implementation of the FolderUpdateListener interface.
FolderUpdateEvent An event triggered whenever a Folder is added, moved, changed or deleted in a View.
ForeignRefreshResult The class holds return information specific to the "foreign" refresh operation.
Group Represents a StarTeam Group.
GroupAccount This class represents a full StarTeam Group account.
GroupNode Describes a group of objects that may be a subgroup of a larger, indexable group.
GroupSortInfo  
HistoryKeyword  
HistoryLine A class containing information specific to a single version entry for expansion of the $History$ keyword.
HiveInfo Describes a vault hive on the server.
HiveManager Manages vault hives on the server.
ImportUtility This class is used internally for the implementation of various import utilities.
IPRange This class represents a range of TCP/IP addresses and the required level of encryption for clients to connect to the StarTeam server.
Item Contextual reference to an object in a StarTeam repository.
ItemAdapter A stub implementation of the ItemListener interface.
ItemBehavior A class that represents the behavior of an Item.
ItemEvent An event triggered whenever an Item is added, moved, changed or deleted in a View.
ItemIDAdapter A stub implementation of the ItemIDListener interface.
ItemIDEvent An event triggered whenever an Item is added, changed or deleted in a View.
ItemList Acts as a temporary collection of Items, It also provides the service of handling efficient retrieval of the properties of the items contained in the list.
ItemListAdapter A stub implementation of the ItemListListener interface.
ItemListEvent An event triggered whenever the list of Items of a given Type has changed in a Folder.
ItemListManager Generates and manages a list of Items.
ItemReference  
ItemRevision A ItemRevision represents a View member level revision of an item.
ItemUpdateAdapter A stub implementation of the ItemUpdateListener interface.
ItemUpdateEvent An event triggered whenever an Item is added, moved, changed or deleted in a View.
KeywordReader A class that extends the java.io.Reader class that can expand or unexpand keywords in a file or other data source.
Label Represents a named configuration of Items.
LabelAdapter A stub implementation of the LabelListener interface.
LabelEvent An event triggered whenever a Label is added, changed or deleted on the server.
LicenseUsage Deprecated.  
Link Represents an instance of an association between two items.
LinkCache Caches links for a given set of items.
LinkEndpoint Represents a link reference to an item.
LinkFactory Supports bulk link creation, on servers that support it.
LinkUpdateAdapter A stub implementation of the LinkUpdateListener interface.
LinkUpdateEvent An event triggered whenever a Link in a LinkCache is added, changed or deleted during a refresh operation.
LogKeyword An implementation of the StarTeam $Log$ keyword.
LogLine A class containing information specific to a single version entry for expansion of the $Log$ keyword.
MatchedACE Used when explaining the results of an access test.
MergePoint This class provides information about how two item revisions are related with respect to merging.
MPXStatusAdapter A stub implementation of the MPXStatusListener interface.
MPXStatusEvent An event triggered whenever an important change occurs in the status of MPX or the MPX event transmitter.
MyUserAccount This class represents the user account information that every user can specify/modify about themselves.
NoKeywords A special Keyword implementation that halts keyword expansion for the rest of a file when encountered.
NotificationAdapter A stub implementation of the NotificationListener interface.
NotificationEvent An event triggered whenever a "notification" for a given Item is added or removed on the server.
NotificationItem This class bundles together information about new "notification" items of a particular type in a particular view that the user may be interested in knowing about.
ObjectACLSecLogID For Object ACL events.
ProcessItem A process item in the context of a given target view.
ProcessItemUsage Indicates the type of operation that created a given process task and its associated process links.
ProductCodes This class defines constant values for the various StarTeam product codes.
Project Represents a StarTeam project which is essentially just a collection of Views.
ProjectAdapter A stub implementation of the ProjectListener interface.
ProjectEvent An event triggered whenever a Project is added, changed or deleted on the server.
PromotionModel This class represents the Promotion model for a view.
PromotionState This class represents a promotion state associated with a promotion model.
Property Each different Type supported by a StarTeam Server (e.g.
PropertyEnums This class provides a conventient place to get the values of various built-in StarTeam enumerated item properties.
PropertyNames This class provides a conventient place to get the names of various built-in StarTeam Item (and some non-item) property names.
QueryAdapter A stub implementation of the QueryListener interface.
QueryEvent An event triggered whenever a Query is added, changed or deleted on the server.
QueryInfo The QueryInfo class implements a query condition to be applied to items of a certain type.
QueryNode A QueryNode represents a boolean expression.
QueryPart A QueryPart object represents a boolean expression on the value of a particular property of an item.
RecycleBin Provides access to the items that have been deleted from a view.
RevisionID A simple class representing a unique revision of an Item in the repository.
SecurityLogEntry  
Server The Server class provides network access to a remote StarTeam Server.
ServerAdministration The ServerAdministration class provides a conventient interface to perform various server level administration commands.
ServerConfiguration  
ServerControlAdapter A stub implementation of the ServerControlListener interface.
ServerControlEvent An event triggered whenever a Server is stopped or restarted.
ServerInfo  
ServerLicenseInfo Information about the licenses registered on a StarTeam Server.
ServerList This class is used to manage a list of ServerInfo objects.
SimpleKeyword A Keyword object that encapsulates information about a File keyword.
SimpleTypedResource A simple implementation of the TypedResource class.
StarTeamClientOptions  
StarTeamFinder A utility class for easily obtaining a connection to a StarTeam server and finding various objects like projects, views, folders and files.
StarTeamURL StarTeamURL uses a URL-like syntax to reference a StarTeam Server, Project, View or Folder.
Status Represents the status of a working file relative to its corresponding file in the repository.
StatusMethod This class provides information about how file status is managed for the client.
SupportedFeatures The SupportedFeatures class contains a number of methods that report whether or not a particular feature is available for a StarTeam server.
SystemPolicy  
Task Represents a StarTeam Task item.
TaskDependency This is a class reprensenting a dependency between two tasks.
Topic Represents a StarTeam Topic.
Translations The Translations class defines the possible localized translations of a particular resource.
TreeItem A type of item with children.
Type Information describing certain StarTeam object types.
TypeAdapter A stub implementation of the TypeListener interface.
TypedResource This is a parent interface for many instances of StarTeam types (e.g.
TypeEvent An event triggered whenever a Type is modified on the server.
TypeNames TypeNames is a class defining pseudo-constants for the names of various types in StarTeam.
User Represents a StarTeam user.
UserAccount Represents a StarTeam user account.
UserAdapter A stub implementation of the UserListener interface.
UserEvent An event triggered whenever a User is added, changed or deleted on the server.
UserGroupSecLogID For User-based security log events.
View Represents a StarTeam View.
ViewAdapter A stub implementation of the ViewListener interface.
ViewConfiguration A class that represents the possible configuration states for a View.
ViewConfigurationDiffer Used to compare two configurations of a given view, triggering FolderUpdateEvents and ItemUpdateEvents describing the changes detected between the two.
ViewEvent An event triggered whenever a View is added, changed or deleted on the server.
ViewPollingAgent Used to periodically poll a given view for recent changes, triggering FolderUpdateEvents and ItemUpdateEvents describing the changes detected since the last poll.
WorkRecord Record of a period of work expended for a task.
Workstation  
 

Exception Summary
CommandAbortedException The CommandAbortedException class is intended to be used to cause a command to be aborted in NetMonitor.
DisembodiedItemException An exception that is thrown when attempting to perform an operation not allowed for a disembodied item.
DuplicateServerListEntryException  
ForeignPasswordException An exception that is raised when a server operation on a foreign archive fails because the foreign password has not been provided.
ItemNotFoundException An exception that is raised when an item with the given ItemID was not found.
LogonException An exception that is raised when logon fails due to an invalid user name or password.
MPXException An MPX-related exception.
NoSuchPropertyException An exception of this class is thrown when an invalid item property was attempted to be accessed.
PasswordExpiredException  
PropertyNotWritableException A PropertyNotWritableException is thrown if an application attempts to change the value of a property that should be considered read only
SDKRuntimeException This is a subclass of java.lang.RuntimeException which may be thrown by the SDK when a runtime error occurs.
ServerException The ServerException class is a client side exception that is thrown when an error on the server is encountered.
ServerUnavailableException An exception that is raised when the server is currently unavailable.
TypeNotFoundException This exception can be thrown when an Item instance is created for an unsupported type.
 



StarTeam SDK 10.4, Build 36
Copyright © 2003-2008 Borland Software Corporation. All rights reserved.