com.appiancorp.suiteapi.collaboration

Class UserSpace

java.lang.Object

com.appiancorp.suiteapi.collaboration.UserSpace

All Implemented Interfaces:

LocalId, java.io.Serializable, java.lang.Cloneable

Deprecated.

@Deprecated
public class UserSpace
extends java.lang.Object
implements LocalId, java.lang.Cloneable

This class encapsulates data regarding the physical disk space available to and occupied by a user.

Copyright: Copyright (c) 2002, 2003

Company: Appian Corporation

Version:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserSpace() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deprecated.
java.lang.Long	getId() Deprecated. Gets the ID of this UserSpace object
java.lang.Double	getMegaBytesAvailable() Deprecated. Gets the number of magabytes of total space that the user has.
java.lang.Long	getMegaBytesFree() Deprecated. Gets the amount of space that is free for the user to store/upload documents
java.lang.Long	getMegaBytesUsed() Deprecated. Gets the amount of space that has been used by the user to store/upload documents
java.lang.Double	getPercentAvailable() Deprecated. Gets the percentage of the user's total space allocation that is left in the application for storage/uploads
java.lang.Double	getRoundedPercentAvailable() Deprecated. Gets the percentage of the user's total space allocation in rounded figures that is left in the application for storage/uploads.
void	setId(java.lang.Long id) Deprecated. Sets the ID of this UserSpace object
void	setMegaBytesAvailable(java.lang.Double megaBytesAvailable) Deprecated. Sets the number of megabytes of space the user has available.
void	setMegaBytesUsed(java.lang.Long Long) Deprecated. Sets the amount of space that has been used by the user to store/upload documents
void	setPercentAvailable(java.lang.Double double1) Deprecated. Register the percentage of the user's total space allocation that is left in the application for storage/uploads

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSpace

public UserSpace()

Deprecated.

Method Detail

getMegaBytesUsed

public java.lang.Long getMegaBytesUsed()

Deprecated.

Gets the amount of space that has been used by the user to store/upload documents

Returns:

the amount of space that has been used by the user in Mbytes

getMegaBytesFree

public java.lang.Long getMegaBytesFree()

Deprecated.

Gets the amount of space that is free for the user to store/upload documents

Returns:

the amount of space that is free for the user in Mbytes

getMegaBytesAvailable

public java.lang.Double getMegaBytesAvailable()

Deprecated.

Gets the number of magabytes of total space that the user has. This value should be the sum of megaBytesUsed and megaBytesFree.

Returns:

Returns the megaBytesAvailable.

setMegaBytesAvailable

public void setMegaBytesAvailable(java.lang.Double megaBytesAvailable)

Deprecated.

Sets the number of megabytes of space the user has available. After this method call is invoked, the user's free space is reset to the new value megaBytesAvailable - megaBytesUsed.

Parameters:

megaBytesAvailable - sets the Total User Space (in megabytes)

getPercentAvailable

public java.lang.Double getPercentAvailable()

Deprecated.

Gets the percentage of the user's total space allocation that is left in the application for storage/uploads

Returns:

the pecentage available

getRoundedPercentAvailable

public java.lang.Double getRoundedPercentAvailable()

Deprecated.

Gets the percentage of the user's total space allocation in rounded figures that is left in the application for storage/uploads. Rounding it makes it easier to represent graphically

Returns:

the pecentage available

setMegaBytesUsed

public void setMegaBytesUsed(java.lang.Long Long)

Deprecated.

Sets the amount of space that has been used by the user to store/upload documents

Parameters:

Long - the amount of space that has been used by the user in Mbytes

setPercentAvailable

public void setPercentAvailable(java.lang.Double double1)

Deprecated.

Register the percentage of the user's total space allocation that is left in the application for storage/uploads

Parameters:

double1 - the percentage available

getId

public java.lang.Long getId()

Deprecated.

Gets the ID of this UserSpace object

Specified by:

getId in interface LocalId

Returns:

the ID of this UserSpace object

See Also:

LocalId.setId(Long)

setId

public void setId(java.lang.Long id)

Deprecated.

Sets the ID of this UserSpace object

Specified by:

setId in interface LocalId

Parameters:

id - the ID of this UserSpace object

See Also:

LocalId.getId()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Deprecated.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException