com.ibm.itim.dataservices.model.domain

Class ScalableAccountTable

java.lang.Object

com.ibm.itim.dataservices.model.domain.ScalableAccountTable

public class ScalableAccountTable
extends java.lang.Object

Class that provides an interface for searching and performing operations on accounts within the context of a defining service. Given the context of a service, single operations can be made against all accounts for that service.

Constructor Summary

Constructors

Constructor and Description
ScalableAccountTable(ServiceEntity service) Constructs the AccountTable with a service as its context.
ScalableAccountTable(ServiceEntity service, boolean isSearchTenant) Constructs the AccountTable with a service as its context.

Method Summary

Modifier and Type	Method and Description
SearchResults	getAll() Returns all accounts hosted by the service including account on concrete and hosted services.
SearchResults	getByFilter(java.lang.String filter) Returns all accounts matching the given filter.
SearchResults	getOwned(java.util.ArrayList attributeList) Returns all owned accounts hosted by the service.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalableAccountTable

public ScalableAccountTable(ServiceEntity service,
                            boolean isSearchTenant)
                     throws ObjectNotFoundException

Constructs the AccountTable with a service as its context.

Parameters:

service - ServiceEntity for context.

Throws:

ObjectNotFoundException - if the profile for the service cannot be found

ScalableAccountTable

public ScalableAccountTable(ServiceEntity service)
                     throws ObjectNotFoundException

Constructs the AccountTable with a service as its context.

Parameters:

service - ServiceEntity for context.

Throws:

ObjectNotFoundException - if the profile for the service cannot be found

Method Detail

getAll

public SearchResults getAll()
                     throws ModelCommunicationException,
                            ObjectNotFoundException

Returns all accounts hosted by the service including account on concrete and hosted services.

Returns:

SearchResults holding AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getOwned

public SearchResults getOwned(java.util.ArrayList attributeList)
                       throws ModelCommunicationException,
                              ObjectNotFoundException

Returns all owned accounts hosted by the service.

Parameters:

attributeList - list of attribute names to return, null or empty for all attributes

Returns:

SearchResults holding owned AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getByFilter

public SearchResults getByFilter(java.lang.String filter)
                          throws ModelCommunicationException,
                                 ObjectNotFoundException

Returns all accounts matching the given filter.

Parameters:

filter - Filter that defines the criteria for returned AccountEntity to meet.

Returns:

SearchResults holding AccountEntities matching filter.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.