Package net.amcintosh.freshbooks.models

Enum Class VisState

java.lang.Object

java.lang.Enum<VisState>

net.amcintosh.freshbooks.models.VisState

All Implemented Interfaces:

Serializable, Comparable<VisState>, Constable

public enum VisState
extends Enum<VisState>

Visibility values for a resource. Mostly used in accounting-type resources, not project-type.
Values are:

• ACTIVE: refers to objects that are both completed and non-completed.
• DELETED: objects are "soft-deleted" meaning they will not show up in list calls by default, and will not count towards finances, account limits, etc., but can be undeleted at any time.
• ARCHIVED: Are hidden from FreshBook's UI by default, but still count towards finances, account limits, etc.

See Also:

• FreshBooks API - Active and Deleted Objects

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE
ARCHIVED
DELETED

Method Summary

Modifier and Type	Method	Description
int	getValue()
static VisState	valueOf(int visState)	Returns the enum constant of this class with the specified name.
static VisState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VisState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACTIVE

public static final VisState ACTIVE

DELETED

public static final VisState DELETED

ARCHIVED

public static final VisState ARCHIVED

Method Details

values

public static VisState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static VisState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static VisState valueOf(int visState)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

visState - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()