org.apache.james.mailboxmanager
Interface ListResult

All Known Implementing Classes:
ListResultImpl

public interface ListResult

Returned by the list method of MailboxRepository and others


Field Summary
static ListResult[] EMPTY_ARRAY
           
static int SELECTABILITY_FLAG_MARKED
          Indicates that RFC3501 Selectability is set to \Marked
static int SELECTABILITY_FLAG_NONE
          Indicates that no RFC3501 Selectability flag is set
static int SELECTABILITY_FLAG_NOSELECT
          Indicates that RFC3501 Selectability is set to \Noselect
static int SELECTABILITY_FLAG_UNMARKED
          Indicates that RFC3501 Selectability is set to \Unmarked
 
Method Summary
 java.lang.String getHierarchyDelimiter()
           
 java.lang.String getName()
           
 int getSelectability()
          Gets the RFC3501 Selectability flag setting.
 boolean isNoInferiors()
          Is this mailbox \Noinferiors as per RFC3501.
 

Field Detail

SELECTABILITY_FLAG_NONE

static final int SELECTABILITY_FLAG_NONE
Indicates that no RFC3501 Selectability flag is set

See Also:
Constant Field Values

SELECTABILITY_FLAG_MARKED

static final int SELECTABILITY_FLAG_MARKED
Indicates that RFC3501 Selectability is set to \Marked

See Also:
Constant Field Values

SELECTABILITY_FLAG_UNMARKED

static final int SELECTABILITY_FLAG_UNMARKED
Indicates that RFC3501 Selectability is set to \Unmarked

See Also:
Constant Field Values

SELECTABILITY_FLAG_NOSELECT

static final int SELECTABILITY_FLAG_NOSELECT
Indicates that RFC3501 Selectability is set to \Noselect

See Also:
Constant Field Values

EMPTY_ARRAY

static final ListResult[] EMPTY_ARRAY
Method Detail

isNoInferiors

boolean isNoInferiors()
Is this mailbox \Noinferiors as per RFC3501.

Returns:
true if marked, false otherwise

getSelectability

int getSelectability()
Gets the RFC3501 Selectability flag setting.

Returns:
SELECTABILITY_FLAG_NONE, SELECTABILITY_FLAG_MARKED, SELECTABILITY_FLAG_NOSELECT, or SELECTABILITY_FLAG_UNMARKED

getHierarchyDelimiter

java.lang.String getHierarchyDelimiter()

getName

java.lang.String getName()
Returns:
full namespace-name


Copyright © 2002-2008 The Apache Software Foundation. All Rights Reserved.