SPUsageDefinition members

An abstract class that is the common interface for defining a usage type. A corresponding SPUsageEntry class is used for doing the actual usage logging.

The SPUsageDefinition type exposes the following members.

Constructors

	Name	Description
	SPUsageDefinition()	The default constructor, which is called implicitly by the default constructors of derived classes.
	SPUsageDefinition(SPFarm)	This constructor initializes the object instance to be used with a specific SPFarm object containing the global settings for the servers, services, and solutions that are installed in a server farm. This constructor is intended for use only by the SPFarm object and should not be used by any other object.
	SPUsageDefinition(SPFarm, String)

Top

Properties

	Name	Description
	DaysToKeepData	Gets or sets the number of days to keep data.
	DaysToKeepDetailedData	This property controls the number of days to keep detailed data. Must be less than DaysToKeepData.
	DaysToKeepUsageFiles	This property controls the number of days to keep detailed data. Must be less than DaysToKeepDetailedData.
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	Gets a detailed string description of this type of SPUsageDefinition.
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	Enabled	Gets or sets a value specifying whether usage logging has been enabled for this type.
	EnableReceivers	Gets or sets a value indicating whether usage receivers are enabled for this usage type.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Hidden	Gets a Boolean value that determines whether the usage definition is shown in the user interface.
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	MaxTotalSizeInBytes	This property stores the maximum SQL storage size for the data of this provider.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Receivers	Gets this usage definition's collection of receivers.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TableColumnsMaxSize	This property returns the maximum length of usage definition column. It is typically used when instantiating an SPColumnDefinition object representing a string column.
	TypeName	Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	UsageDatabaseEnabled
	UsageEntryType	Contains the type of the SPUsageEntry class that corresponds to this SPUsageDefinition.
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

	Name	Description
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetLocal<T>	This static method is used instead of the constructor to create a new instance of the derived SPUsageDefinition class, if necessary, and to retrieve it from the database.
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	ImportEntries	Called during import of usage data with the actual usage entries that have been collected from the usage log files.
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPreCreate	(Inherited from SPPersistedObject.)
	ProcessData	Called daily by the usage processing timer job. Can be used to process and/or aggregate data for this usage definition.
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	TruncateData	Called daily by the usage processing timer job. Can be used to purge all data for this usage definition.
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Validate	Validates the properties of this usage definition (Overrides SPPersistedObject.Validate().)

Top

See also

Reference

SPUsageDefinition class

Microsoft.SharePoint.Administration namespace