Blue Mind
Release 1.0

net.bluemind.core.api.directory
Class DirectoryQuery

java.lang.Object
  extended by net.bluemind.core.api.Query
      extended by net.bluemind.core.api.directory.DirectoryQuery
All Implemented Interfaces:
java.io.Serializable

public class DirectoryQuery
extends Query

DirectoryQuery is a Query used in Blue Mind API to query DirectoryEntry

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.bluemind.core.api.Query
pagination, sort
 
Constructor Summary
DirectoryQuery()
          Instantiate a new DirectoryQuery All entry types are searched by default
Results are sort by ascending name by default
 
Method Summary
 void addType(DirectoryEntryType type)
          Add a DirectoryEntryType to DirectoryEntryType queried set
 java.lang.String getDelegation()
          Get queried delegation
 java.lang.Integer getDomainId()
          Get queried Domain ID
 java.util.List<java.lang.Integer> getExcludeEntityIds()
          Get list of DirectoryEntry ID to exclude from response, even if the match DirectoryQuery Take care of DirectoryEntryType
 java.util.List<java.lang.Integer> getIncludeEntityIds()
          Set list of DirectoryEntry ID to include, even if they don't match DirectoryQuery Take care of DirectoryEntryType
 java.lang.String getName()
          Get DirectoryEntry queried name
 java.util.Set<DirectoryEntryType> getTypes()
          Get DirectoryEntry queried DirectoryEntryType set
 java.lang.Boolean isArchive()
          Get queried archive status
 void setArchive(java.lang.Boolean archive)
          Set queried archive status
 void setDelegation(java.lang.String delegation)
          Set queried delegation
 void setDomainId(java.lang.Integer domainId)
          Set queried Domain ID
 void setExcludeEntityIds(java.util.List<java.lang.Integer> excludeEntityIds)
          Set list of DirectoryEntry ID to exclude from response, even if they match DirectoryQuery Take care of DirectoryEntryType
 void setIncludeEntityIds(java.util.List<java.lang.Integer> includeEntityIds)
          Set list of DirectoryEntry ID to include, even if they don't match DirectoryQuery Take care of DirectoryEntryType
 void setName(java.lang.String name)
          Set DirectoryEntry queried name
 void setType(java.util.Set<DirectoryEntryType> types)
          Set DirectoryEntry queried DirectoryEntryType set
 
Methods inherited from class net.bluemind.core.api.Query
getPagination, getSort, setPagination, setSort
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectoryQuery

public DirectoryQuery()
Instantiate a new DirectoryQuery

All entry types are searched by default
Results are sort by ascending name by default

Method Detail

getName

public java.lang.String getName()
Get DirectoryEntry queried name

Returns:
queried DirectoryEntry name

setName

public void setName(java.lang.String name)
Set DirectoryEntry queried name


getTypes

public java.util.Set<DirectoryEntryType> getTypes()
Get DirectoryEntry queried DirectoryEntryType set

Returns:
queried DirectoryEntry DirectoryEntryType set

setType

public void setType(java.util.Set<DirectoryEntryType> types)
Set DirectoryEntry queried DirectoryEntryType set


addType

public void addType(DirectoryEntryType type)
Add a DirectoryEntryType to DirectoryEntryType queried set

Parameters:
type - DirectoryEntryType to add

getDomainId

public java.lang.Integer getDomainId()
Get queried Domain ID

Returns:
queried Domain ID

setDomainId

public void setDomainId(java.lang.Integer domainId)
Set queried Domain ID

Parameters:
domainId - queried Domain ID

getDelegation

public java.lang.String getDelegation()
Get queried delegation

Returns:
queried delegation

setDelegation

public void setDelegation(java.lang.String delegation)
Set queried delegation

Parameters:
delegation - queried delegation

getExcludeEntityIds

public java.util.List<java.lang.Integer> getExcludeEntityIds()
Get list of DirectoryEntry ID to exclude from response, even if the match DirectoryQuery

Take care of DirectoryEntryType

Returns:
list of DirectoryEntry ID to exclude from response

setExcludeEntityIds

public void setExcludeEntityIds(java.util.List<java.lang.Integer> excludeEntityIds)
Set list of DirectoryEntry ID to exclude from response, even if they match DirectoryQuery

Take care of DirectoryEntryType

Parameters:
excludeEntityIds - list of DirectoryEntry ID to exclude from response

getIncludeEntityIds

public java.util.List<java.lang.Integer> getIncludeEntityIds()
Set list of DirectoryEntry ID to include, even if they don't match DirectoryQuery

Take care of DirectoryEntryType

Returns:
list of DirectoryEntry ID to include

setIncludeEntityIds

public void setIncludeEntityIds(java.util.List<java.lang.Integer> includeEntityIds)
Set list of DirectoryEntry ID to include, even if they don't match DirectoryQuery

Take care of DirectoryEntryType

Parameters:
includeEntityIds - list of DirectoryEntry ID to include

isArchive

public java.lang.Boolean isArchive()
Get queried archive status

Returns:
archive status

setArchive

public void setArchive(java.lang.Boolean archive)
Set queried archive status

Parameters:
archive - archive status

Blue Mind
Release 1.0