au.gov.nehta.vendorlibrary.pcehr.clients.common.type
Enum DocumentStatus

java.lang.Object
  extended by java.lang.Enum<DocumentStatus>
      extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.type.DocumentStatus
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DocumentStatus>

public enum DocumentStatus
extends java.lang.Enum<DocumentStatus>

A status of a document in the document repository.


Enum Constant Summary
APPROVED
          Approved document status.
DELETED
          Deleted document status.
DEPRECATED
          Deprecated document status.
SUBMITTED
          Submitted document status.
 
Method Summary
static DocumentStatus fromCode(java.lang.String code)
          Checks that supplied status is valid.
 java.lang.String getCode()
          Returns the value of 'code'.
static DocumentStatus valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DocumentStatus[] 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

SUBMITTED

public static final DocumentStatus SUBMITTED
Submitted document status.


APPROVED

public static final DocumentStatus APPROVED
Approved document status.


DELETED

public static final DocumentStatus DELETED
Deleted document status.


DEPRECATED

public static final DocumentStatus DEPRECATED
Deprecated document status.

Method Detail

values

public static DocumentStatus[] 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 (DocumentStatus c : DocumentStatus.values())
    System.out.println(c);

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

valueOf

public static DocumentStatus valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getCode

public java.lang.String getCode()
Returns the value of 'code'.

Returns:
value of code

fromCode

public static DocumentStatus fromCode(java.lang.String code)
Checks that supplied status is valid.

Parameters:
code - String code to check against list of available enum entries.
Returns:
Corresponding DocumentStatus if it exists.