oracle.ifs.server
Class S_ContentQuota

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryObject
        |
        +--oracle.ifs.server.S_TieLibraryObject
              |
              +--oracle.ifs.server.S_PublicObject
                    |
                    +--oracle.ifs.server.S_TiePublicObject
                          |
                          +--oracle.ifs.server.S_ApplicationObject
                                |
                                +--oracle.ifs.server.S_TieApplicationObject
                                      |
                                      +--oracle.ifs.server.S_ContentQuota

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:

S_TieContentQuota

public class S_ContentQuota

extends S_TieApplicationObject

A ContentQuota contains information that defines how much storage space in iFS is allocated and consumed by the DirectoryUser. For quota enforcement, the ContentQuota object must be enabled.

See Also:

S_LibraryService, S_LibrarySession

Method Summary

protected void	calculateConsumedStorage() Calculates the current consumed storage for the DirectoryUser and updates this ContentQuota object.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition def) Update any system attributes appropriate for creating this object; in this case, derive the UniqueName.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition def) Performs the necessary operations before an update.
protected long	getAllocatedStorage() Gets the amount of allocated storage.
S_PublicObject	getAssociatedPublicObject() Gets the PublicObject associated with this ContentQuota object.
protected long	getConsumedStorage() Gets the amount of consumed storage.
protected boolean	isEnabled() Determines whether this ContentQuota is enabled.

Methods inherited from class oracle.ifs.server.S_ApplicationObject

isVersionable

Methods inherited from class oracle.ifs.server.S_PublicObject

addRelationship, checkAccess, deriveDefinition, extendedPostInsert, extendedPostUpdate, extendedPreFree, getCategories, getCategories, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getReferencingFolders, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getVersionDescriptions, hasNameAttribute, isLocked, removeRelationship, verifyCanUseContentQuota

Methods inherited from class oracle.ifs.server.S_LibraryObject

equals, free, getAttribute, getAttributeByUpperCaseName, getClassId, getClassObject, getId, getSession, handleEvent, isTraced, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Method Detail

getAssociatedPublicObject

public S_PublicObject getAssociatedPublicObject()
                                         throws IfsException

Gets the PublicObject associated with this ContentQuota object.

Returns:

the PublicObject

Throws:

IfsException - if operation fails

isEnabled

protected boolean isEnabled()
                     throws IfsException

Determines whether this ContentQuota is enabled.

Returns:

true if enabled

Throws:

if - operation fails

getAllocatedStorage

protected long getAllocatedStorage()
                            throws IfsException

Gets the amount of allocated storage. Returns 0 if no storage value is set.

Returns:

allocated storage (in bytes)

Throws:

IfsException - if operation fails.

getConsumedStorage

protected long getConsumedStorage()
                           throws IfsException

Gets the amount of consumed storage. Returns 0 if no storage value is set.

Returns:

consumed storage (in bytes)

Throws:

IfsException - if operation fails.

extendedPreInsert

protected void extendedPreInsert(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Update any system attributes appropriate for creating this object; in this case, derive the UniqueName.

Overrides:

extendedPreInsert in class S_PublicObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPreUpdate

protected void extendedPreUpdate(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Performs the necessary operations before an update.

Overrides:

extendedPreUpdate in class S_PublicObject

Parameters:

opState - current state of the operation

def - current object definition to be updated

Throws:

IfsException - if the operation fails.

calculateConsumedStorage

protected void calculateConsumedStorage()
                                 throws IfsException

Calculates the current consumed storage for the DirectoryUser and updates this ContentQuota object.

Throws:

IfsException - if the operation fails