com.starbase.starteam
Class Audit

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.NamedCacheRef
              |
              +--com.starbase.starteam.TypedResource
                    |
                    +--com.starbase.starteam.SimpleTypedResource
                          |
                          +--com.starbase.starteam.Item
                                |
                                +--com.starbase.starteam.Audit

All Implemented Interfaces:

java.lang.Cloneable, ISecurable, ISecurableObject

public class Audit

extends Item

Represents a StarTeam Audit record

Nested Class Summary

Nested classes inherited from class com.starbase.starteam.Item

Item.LockType

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	getItemClass2Name() Returns the name of the second "operand" item's type (if any).
java.lang.String	getItemClass3Name() Returns the name of the third "operand" item's type (if any).
java.lang.String	getItemClassName() Returns the name of the audited item's type.
java.lang.String	getItemDescriptor() Returns the primary descriptor for the underlying audited object.
java.lang.String	getItemDescriptor2() Returns the primary descriptor for the second "operand" object (if any).
java.lang.String	getItemDescriptor3() Returns the primary descriptor for the third "operand" object (if any).
int	hashCode() returns a unique hash for all instances of this type

Methods inherited from class com.starbase.starteam.Item

acquireOwnership, addAttachment, copy, createAttachment, createAttachmentFromFile, createItem, deleteMergePoint, discard, get, getACL, getAllLabels, getAttachedLabels, getAttachment, getAttachmentIDs, getAttachmentNames, getAttachmentToFile, getBehavior, getBranchRevisionFromDotNotation, getByProperty, getByPropertyID, getByteArray, getCachedProperties, getComment, getCommonAncestor, getCreatedBy, getCreatedTime, getDeletedTime, getDeletedUserID, getDisplayValue, getDotNotation, getDouble, getEnumDisplayName, getFlag, getFlagDisplayName, getFromHistoryByDate, getFromHistoryByLabelID, getFromHistoryByVersion, getHistory, getID, getInt, getIntArray, getItemID, getItemRevisions, getLocker, getMergeHistory, getModifiedBy, getModifiedTime, getMyLock, getNewRevisionComment, getObjectID, getOLEDate, getOwner, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getParentRevision, getPossibleFlag, getPossibleReadStatus, getPossibleValues, getPropertyNames, getReadStatus, getReadStatusDisplayName, getReference, getReferences, getRevisionNumber, getRootObjectID, getServer, getString, getType, getTypeNames, getView, getViewVersion, getViewVersionFromDotNotation, hasPermission, hasValues, isBranchable, isDeleted, isDirty, isDisembodied, isEqualTo, isFromHistory, isNew, isRefreshRequired, isRefreshRequired, isReverseShareRecommended, isRootShare, lock, modifyFlagForUser, modifyReadStatusForUser, move, moveTo, populate, populate, put, putByPropertyID, putLock, recordMergePoint, refresh, refresh, remove, removeAttachment, resolveMergePoint, reverseShareTo, setACL, setBehavior, setBranchOnChange, setComment, setFixedConfig, setFloatingConfig, shareTo, smartShareTo, toDebugString, toString, unlock, update, updateRevisionComment

Methods inherited from class com.starbase.starteam.TypedResource

addToIntArray, removeFromIntArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getItemDescriptor

public java.lang.String getItemDescriptor()

Returns the primary descriptor for the underlying audited object.

Returns:

the primary descriptor for the underlying audited object.

See Also:

Catalog.getPrimaryDescriptor(int), PropertyNames.AUDIT_CLASS_ID, PropertyNames.AUDIT_OBJECT_ID

getItemClassName

public java.lang.String getItemClassName()

Returns the name of the audited item's type.

Returns:

the name of the audited item's type.

See Also:

PropertyNames.AUDIT_CLASS_ID

getItemDescriptor2

public java.lang.String getItemDescriptor2()

Returns the primary descriptor for the second "operand" object (if any). Not available on older servers.

Returns:

the primary descriptor for the second "operand" object

See Also:

Catalog.getPrimaryDescriptor(int), PropertyNames.AUDIT_TARGET_2_CLASS_ID, PropertyNames.AUDIT_TARGET_2_OBJECT_ID, SupportedFeatures.hasNewAuditProperties()

getItemClass2Name

public java.lang.String getItemClass2Name()

Returns the name of the second "operand" item's type (if any). Not available on older servers.

Returns:

the name of the audited item's type.

See Also:

PropertyNames.AUDIT_TARGET_2_CLASS_ID, SupportedFeatures.hasNewAuditProperties()

getItemDescriptor3

public java.lang.String getItemDescriptor3()

Returns the primary descriptor for the third "operand" object (if any). Not available on older servers.

Returns:

the primary descriptor for the second "operand" object

See Also:

Catalog.getPrimaryDescriptor(int), PropertyNames.AUDIT_TARGET_3_CLASS_ID, PropertyNames.AUDIT_TARGET_3_OBJECT_ID, SupportedFeatures.hasNewAuditProperties()

getItemClass3Name

public java.lang.String getItemClass3Name()

Returns the name of the third "operand" item's type (if any). Not available on older servers.

Returns:

the name of the audited item's type.

See Also:

PropertyNames.AUDIT_TARGET_3_CLASS_ID, SupportedFeatures.hasNewAuditProperties()

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class Item

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class Item

Returns:

int a unique hash for all instances of this type