de.starface.integration.uci.java.v30.values
Enum FaxListProperties

java.lang.Object
  extended by java.lang.Enum<FaxListProperties>
      extended by de.starface.integration.uci.java.v30.values.FaxListProperties
All Implemented Interfaces:
Serializable, Comparable<FaxListProperties>

public enum FaxListProperties
extends Enum<FaxListProperties>

This enum holds constants with the property names of the fax list as returned by UcpFaxListRequests.getFaxList(Date, Date, String, String, String, String, int, int)


Enum Constant Summary
countLimit
          The limit used for the retrieval of this list regarding the given time constraints and restrictions as Integer
countOffset
          The offset used for the retrieval of this list regarding the given time constraints and restrictions as Integer
entries
          The fax list entries in this list as List of Map with properties as defined in FaxListEntryProperties
folderRestriction
          The entries are restricted to those in the given folder with one of the values of FaxListEntryFolder as String
groupRestriction
          The entries are restricted to faxes belonging to the group with the given id or to faxes that do not belong to any group if GroupRestriction.NON_GROUP is given.
orderDirection
          The entries are ordered in the given direction.
orderProperty
          The entries are ordered by the given property.
receivedAfter
          The entries received after this point of time given as Date
receivedBefore
          The entries received before this point of time given as Date
totalCount
          The total count of available entries on the server regarding the given time constraints and restrictions as Integer.
 
Method Summary
 Class<?> getType()
           
static FaxListProperties valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FaxListProperties[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

receivedBefore

public static final FaxListProperties receivedBefore
The entries received before this point of time given as Date


receivedAfter

public static final FaxListProperties receivedAfter
The entries received after this point of time given as Date


folderRestriction

public static final FaxListProperties folderRestriction
The entries are restricted to those in the given folder with one of the values of FaxListEntryFolder as String


groupRestriction

public static final FaxListProperties groupRestriction
The entries are restricted to faxes belonging to the group with the given id or to faxes that do not belong to any group if GroupRestriction.NON_GROUP is given. If an empty String is given no restriction is used.


orderProperty

public static final FaxListProperties orderProperty
The entries are ordered by the given property. This may be one of the properties in FaxListEntryProperties as String


orderDirection

public static final FaxListProperties orderDirection
The entries are ordered in the given direction. This may be one of the values in OrderDirection as String


countOffset

public static final FaxListProperties countOffset
The offset used for the retrieval of this list regarding the given time constraints and restrictions as Integer


countLimit

public static final FaxListProperties countLimit
The limit used for the retrieval of this list regarding the given time constraints and restrictions as Integer


totalCount

public static final FaxListProperties totalCount
The total count of available entries on the server regarding the given time constraints and restrictions as Integer.


entries

public static final FaxListProperties entries
The fax list entries in this list as List of Map with properties as defined in FaxListEntryProperties

Method Detail

values

public static FaxListProperties[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (FaxListProperties c : FaxListProperties.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static FaxListProperties valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
NullPointerException - if the argument is null

getType

public Class<?> getType()
Returns:
the java type of the property


Copyright © 2012 STARFACE GmbH. All rights reserved.