com.starteam
Class Audit

java.lang.Object
  com.starteam.TypedResource
      com.starteam.LiveObject
          com.starteam.TrackedObject
              com.starteam.VersionedObject
                  com.starteam.ViewMember
                      com.starteam.Item
                          com.starteam.Audit

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public final class Audit
extends Item

Represents a StarTeam Audit record

Nested Class Summary

static class	Audit.EventID EventID of the Audit
static class	Audit.Type The Audit Type

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

Item.WebCacheItem

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

ViewMember.LockType, ViewMember.MyLock, ViewMember.ShareState, ViewMember.WebCacheViewMember

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

VersionedObject.WebCacheVersionedObject

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

TrackedObject.WebCacheTrackedObject

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

LiveObject.WebCacheLiveObject

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

TypedResource.BranchState

Method Summary

Audit.EventID	getEventID() Returns the EventID of this Audit.
java.lang.String	getInfo1Property() returns auxiliary information for the first "operand" object (if any)
java.lang.String	getInfo2Property() returns auxiliary information for the second "operand" object (if any)
java.lang.String	getInfo3Property() returns auxiliary information for the third "operand" object (if any)
java.lang.String	getItemClass1Name() Returns the name of the audited item's type.
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	getItemDescriptor1() 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).
Audit.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this Audit.
DateTime	getRevisionTime1Property() returns the revision time for the first "operand" object (if any)
DateTime	getRevisionTime2Property() returns the revision time for the second "operand" object (if any)
DateTime	getRevisionTime3Property() returns the revision time for the third "operand" object (if any)
User	getUser() Get the user who caused this audit.
boolean	isReadOnly() Determines whether or not the given item is read-only.
java.lang.String	toString() Returns the item class name of this audit.

Methods inherited from class com.starteam.Item

copy, deleteMergePoint, getCommonAncestor, getDebugString, getDisplayableProperties, getItemID, getMergeHistory, getNewRevisionComment, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getSharedChangePackages, getSharedTraces, isEqualTo, isReverseShareRecommended, moveTo, recordMergePoint, remove, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo, shareTo, smartShareTo

Methods inherited from class com.starteam.ViewMember

equals, findLinks, getAllLabels, getAllShares, getAttachedLabels, getAttachments, getBehavior, getCache, getComment, getDeletedBy, getDeletedTime, getDisplayValue, getDotNotation, getExclusiveLocker, getExternalID, getExternalURL, getFromHistory, getFromHistory, getFromHistory, getFromHistory, getHistory, getID, getIntegerArrayValue, getLocker, getMyLockType, getParentRevision, getPresentationID, getRights, getRootObjectID, getShare, getShare, getTraces, getValue, getView, getViewMemberRevisions, getViewVersion, getVMID, hashCode, hasPermissions, isBookmarked, isBranchable, isDeleted, isDisembodied, isEqualTo, isRootShare, isUnread, lockExclusive, lockExclusive, lockNonExclusive, modifyBookmark, modifyReadStatus, putLock, setAttachments, setBehavior, setBranchOnChange, setComment, setExternalID, setExternalURL, setFixedConfiguration, setFloatingConfiguration, setRights, setValue, unlock, update, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject

getBranchRevision, getRevisionNumber, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject

getCreatedBy, getCreatedTime, toStarTeamURL

Methods inherited from class com.starteam.TypedResource

addToIntegerArray, getBooleanValue, getByteArrayValue, getCachedProperties, getContentValue, getDateTimeValue, getDateValue, getDisplayName, getDoubleValue, getEnumDisplayName, getEnumeratedValues, getIntegerValue, getLinkValue, getLongValue, getObjectID, getPossibleValues, getServer, 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

getServer, getType

Method Detail

getItemDescriptor1

public java.lang.String getItemDescriptor1()

Returns the primary descriptor for the underlying audited object.

Returns:

the primary descriptor for the underlying audited object.

See Also:

Catalog.getPrimaryDescriptor(int)

getItemClass1Name

public java.lang.String getItemClass1Name()

Returns the name of the audited item's type.

Returns:

the name of the audited item's type.

getItemDescriptor2

public java.lang.String getItemDescriptor2()

Returns the primary descriptor for the second "operand" object (if any).

Returns:

the primary descriptor for the second "operand" object

See Also:

Catalog.getPrimaryDescriptor(int)

getItemClass2Name

public java.lang.String getItemClass2Name()

Returns the name of the second "operand" item's type (if any).

Returns:

the name of the audited item's type.

getItemDescriptor3

public java.lang.String getItemDescriptor3()

Returns the primary descriptor for the third "operand" object (if any).

Returns:

the primary descriptor for the third "operand" object

See Also:

Catalog.getPrimaryDescriptor(int)

getRevisionTime1Property

public DateTime getRevisionTime1Property()

returns the revision time for the first "operand" object (if any)

Returns:

the revision time for the first "operand" object

getRevisionTime2Property

public DateTime getRevisionTime2Property()

returns the revision time for the second "operand" object (if any)

Returns:

the revision time for the second "operand" object

getRevisionTime3Property

public DateTime getRevisionTime3Property()

returns the revision time for the third "operand" object (if any)

Returns:

the revision time for the third "operand" object

getInfo1Property

public java.lang.String getInfo1Property()

returns auxiliary information for the first "operand" object (if any)

Returns:

auxiliary information for the first "operand" object

getInfo2Property

public java.lang.String getInfo2Property()

returns auxiliary information for the second "operand" object (if any)

Returns:

auxiliary information for the second "operand" object

getInfo3Property

public java.lang.String getInfo3Property()

returns auxiliary information for the third "operand" object (if any)

Returns:

auxiliary information for the third "operand" object

getItemClass3Name

public java.lang.String getItemClass3Name()

Returns the name of the third "operand" item's type (if any).

Returns:

the name of the audited item's type.

getUser

public User getUser()

Get the user who caused this audit.

Returns:

The user who caused this audit.

getEventID

public Audit.EventID getEventID()

Returns the EventID of this Audit.

Returns:

The EventID of this Audit.

See Also:

Audit.EventID, Audit.Type.EventIDProperty, Audit.Type.PropertyCollection.EVENT_ID

isReadOnly

public boolean isReadOnly()

Determines whether or not the given item is read-only.

Overrides:

isReadOnly in class ViewMember

Returns:

true; Audit items are always read-only.

getProperties

public Audit.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this Audit.

Returns:

the PropertyCollection for this Audit

toString

public java.lang.String toString()

Returns the item class name of this audit.

Overrides:

toString in class Item

Returns:

the item class name of this audit.