com.filenet.api.admin
Interface StorageArea

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable
All Known Subinterfaces:
DatabaseStorageArea, FileStorageArea, FixedStorageArea

public interface StorageArea
extends RepositoryObject, Subscribable, IndependentlyPersistableObject

Represents the physical storage location where content will be stored. This base, abstract class has three concrete subclasses: DatabaseStorageArea, FileStorageArea, and FixedStorageArea. A FixedStorageArea object is associated with a FixedContentDevice when it is created.

The concrete classes are customizable. This means that you can add custom properties to them (and to the base class) and create custom subclasses. By customizing the concrete classes, you can add custom criteria for selecting storage areas via a StoragePolicy.

Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscribable


Method Summary
 CachedContentOption get_AllowsContentToBeCached()
          Returns the value of the AllowsContentToBeCached property.
 java.lang.Boolean get_AllowsDelete()
          Returns the value of the AllowsDelete property.
 EventSet get_AuditedEvents()
          Returns the value of the AuditedEvents property.
 java.util.Date get_ClosureDate()
          Returns the value of the ClosureDate property.
 java.lang.Double get_ContentElementCount()
          Returns the value of the ContentElementCount property.
 java.lang.Double get_ContentElementKBytes()
          Returns the value of the ContentElementKBytes property.
 java.lang.Double get_ContentElementsCreated()
          Returns the value of the ContentElementsCreated property.
 java.lang.Double get_ContentElementsDeleted()
          Returns the value of the ContentElementsDeleted property.
 java.lang.String get_Creator()
          Returns the value of the Creator property.
 java.util.Date get_DateCreated()
          Returns the value of the DateCreated property.
 java.util.Date get_DateLastModified()
          Returns the value of the DateLastModified property.
 java.lang.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 java.lang.String get_DisplayName()
          Returns the value of the DisplayName property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 java.lang.Double get_MaximumContentElements()
          Returns the value of the MaximumContentElements property.
 java.lang.Double get_MaximumSizeKBytes()
          Returns the value of the MaximumSizeKBytes property.
 AccessPermissionList get_Permissions()
          Returns the value of the Permissions property.
 ResourceStatus get_ResourceStatus()
          Returns the value of the ResourceStatus property.
 java.lang.Integer get_RetentionPeriod()
          Returns the value of the RetentionPeriod property.
 Site get_Site()
          Returns the value of the Site property.
 void set_AllowsContentToBeCached(CachedContentOption value)
          Sets the value of the AllowsContentToBeCached property.
 void set_AllowsDelete(java.lang.Boolean value)
          Sets the value of the AllowsDelete property.
 void set_ClosureDate(java.util.Date value)
          Sets the value of the ClosureDate property.
 void set_Creator(java.lang.String value)
          Sets the value of the Creator property.
 void set_DateCreated(java.util.Date value)
          Sets the value of the DateCreated property.
 void set_DateLastModified(java.util.Date value)
          Sets the value of the DateLastModified property.
 void set_DescriptiveText(java.lang.String value)
          Sets the value of the DescriptiveText property.
 void set_DisplayName(java.lang.String value)
          Sets the value of the DisplayName property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_MaximumContentElements(java.lang.Double value)
          Sets the value of the MaximumContentElements property.
 void set_MaximumSizeKBytes(java.lang.Double value)
          Sets the value of the MaximumSizeKBytes property.
 void set_Permissions(AccessPermissionList value)
          Sets the value of the Permissions property.
 void set_ResourceStatus(ResourceStatus value)
          Sets the value of the ResourceStatus property.
 void set_RetentionPeriod(java.lang.Integer value)
          Sets the value of the RetentionPeriod property.
 void set_Site(Site value)
          Sets the value of the Site property.
 EngineRuntimeException[] validateContent(ContentValidationRequest[] validations)
          Performs a batch of content validation requests.
 void validateContent(IndependentlyPersistableObject contentObject, int contentElementIndex)
          Validates that the content location recorded in the object store matches the actual location on the physical device.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Creator

java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.


set_Creator

void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.


get_DateCreated

java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.


set_DateCreated

void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.


get_LastModifier

java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.


set_LastModifier

void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.


set_DateLastModified

void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_AuditedEvents

EventSet get_AuditedEvents()
Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.


get_Permissions

AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.


set_Permissions

void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.


get_ResourceStatus

ResourceStatus get_ResourceStatus()
Returns the value of the ResourceStatus property. For more information, see ResourceStatus Property.


set_ResourceStatus

void set_ResourceStatus(ResourceStatus value)
Sets the value of the ResourceStatus property. For more information, see ResourceStatus Property.


get_AllowsContentToBeCached

CachedContentOption get_AllowsContentToBeCached()
Returns the value of the AllowsContentToBeCached property. For more information, see AllowsContentToBeCached Property.


set_AllowsContentToBeCached

void set_AllowsContentToBeCached(CachedContentOption value)
Sets the value of the AllowsContentToBeCached property. For more information, see AllowsContentToBeCached Property.


get_ClosureDate

java.util.Date get_ClosureDate()
Returns the value of the ClosureDate property. For more information, see ClosureDate Property.


set_ClosureDate

void set_ClosureDate(java.util.Date value)
Sets the value of the ClosureDate property. For more information, see ClosureDate Property.


get_ContentElementCount

java.lang.Double get_ContentElementCount()
Returns the value of the ContentElementCount property. For more information, see ContentElementCount Property.


get_ContentElementsCreated

java.lang.Double get_ContentElementsCreated()
Returns the value of the ContentElementsCreated property. For more information, see ContentElementsCreated Property.


get_ContentElementsDeleted

java.lang.Double get_ContentElementsDeleted()
Returns the value of the ContentElementsDeleted property. For more information, see ContentElementsDeleted Property.


get_ContentElementKBytes

java.lang.Double get_ContentElementKBytes()
Returns the value of the ContentElementKBytes property. For more information, see ContentElementKBytes Property.


get_DisplayName

java.lang.String get_DisplayName()
Returns the value of the DisplayName property. For more information, see DisplayName Property.


set_DisplayName

void set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. For more information, see DisplayName Property.


get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_MaximumContentElements

java.lang.Double get_MaximumContentElements()
Returns the value of the MaximumContentElements property. For more information, see MaximumContentElements Property.


set_MaximumContentElements

void set_MaximumContentElements(java.lang.Double value)
Sets the value of the MaximumContentElements property. For more information, see MaximumContentElements Property.


get_MaximumSizeKBytes

java.lang.Double get_MaximumSizeKBytes()
Returns the value of the MaximumSizeKBytes property. For more information, see MaximumSizeKBytes Property.


set_MaximumSizeKBytes

void set_MaximumSizeKBytes(java.lang.Double value)
Sets the value of the MaximumSizeKBytes property. For more information, see MaximumSizeKBytes Property.


get_Site

Site get_Site()
Returns the value of the Site property. For more information, see Site Property.


set_Site

void set_Site(Site value)
Sets the value of the Site property. For more information, see Site Property.


get_AllowsDelete

java.lang.Boolean get_AllowsDelete()
Returns the value of the AllowsDelete property. For more information, see AllowsDelete Property.


set_AllowsDelete

void set_AllowsDelete(java.lang.Boolean value)
Sets the value of the AllowsDelete property. For more information, see AllowsDelete Property.


get_RetentionPeriod

java.lang.Integer get_RetentionPeriod()
Returns the value of the RetentionPeriod property. For more information, see RetentionPeriod Property.


set_RetentionPeriod

void set_RetentionPeriod(java.lang.Integer value)
Sets the value of the RetentionPeriod property. For more information, see RetentionPeriod Property.


validateContent

void validateContent(IndependentlyPersistableObject contentObject,
                     int contentElementIndex)
Validates that the content location recorded in the object store matches the actual location on the physical device. For non-federated content, this method also verifies that the content size is the same as when the content was created. See the validateContent(validations) form of this method for a list of exception codes that may result from a failed validation attempt.

Characteristics of validateContent include:

Parameters:
contentObject - The Document or Annotation object to validate.
contentElementIndex - The zero-based index value of the content element to validate. A value of "0" will validate the primary content element.

validateContent

EngineRuntimeException[] validateContent(ContentValidationRequest[] validations)
Performs a batch of content validation requests. See the validateContent(contentObject, contentElementIndex) form of this method for a list of content validation characteristics. There isn't a limit on the number of content validation requests that can be performed in a single operation. However, all validations must complete within the time limit of a single request to the server. Therefore, if too many validations are requested, a request timeout exception is likely to occur.

The exception codes that may result from a failed validation attempt are:

Parameters:
validations - An array of ContentValidationRequest objects.
Returns:
An array of EngineRuntimeException objects.


© Copyright IBM Corporation 2006, 2008. All rights reserved.