Interface IDirectoryManager

All Superinterfaces:

IDisposable, IEntity

public interface IDirectoryManager
extends IEntity

Manages the directories.

Method Summary

Modifier and Type	Method	Description
int	createContactProfile(int directoryId, ContactProfileRequest request)	Creates a contact profile.
int	createContactProfileByAttributes(int directoryId, Attribute[] values)	Creates a contact profile.
int	createDirectory(DirectoryCreateRequest request)	Creates a directory.
void	deleteContactProfileById(int directoryId, int contactProfileId)	Deletes a contact profile.
void	deleteContactProfileByUniqueId(int directoryId, String uniqueId)	Deletes a contact profile.
void	deleteDirectory(String directoryName)	Deletes a directory.
ContactProfile	getContactProfileById(int directoryId, int contactProfileId)	Gets the specified contact profile.
ContactProfile	getContactProfileById(int directoryId, int contactProfileId, PurposeFilter purposeFilter)	Gets the specified contact profile.
Attribute[]	getContactProfileByIdAsAttributes(int directoryId, int contactProfileId, String[] columns)	Gets the specified contact profile as attributes.
Attribute[]	getContactProfileByIdAsAttributes(int directoryId, int contactProfileId, String[] columns, PurposeFilter purposeFilter)	Gets the specified contact profile as attributes.
ContactProfile	getContactProfileByUniqueId(int directoryId, String uniqueId)	Gets the specified contact profile.
ContactProfile	getContactProfileByUniqueId(int directoryId, String uniqueId, PurposeFilter purposeFilter)	Gets the specified contact profile.
Attribute[]	getContactProfileByUniqueIdAsAttributes(int directoryId, String uniqueId, String[] columns)	Gets the specified contact profile as attributes.
Attribute[]	getContactProfileByUniqueIdAsAttributes(int directoryId, String uniqueId, String[] columns, PurposeFilter purposeFilter)	Gets the specified contact profile as attributes.
int	getContactProfileCount(int directoryId, String sql)	Gets the count of the contact profile.
IContactProfileCursor	getContactProfileCursor(int cursorId)	Gets the contact profile cursor.
Attribute[]	getContactProfileFieldsFormatted(int directoryId, int contactProfileId)	Gets the formatted contact profile fields.
Attribute[]	getContactProfileFieldsFormatted(int directoryId, int contactProfileId, PurposeFilter purposeFilter)	Gets the formatted contact profile fields.
TableSchema	getContactProfileTableSchema(int directoryId)	Gets the table schema of the contact profile.
IContactProfileUploader	getContactProfileUploaderById(int contactProfileUploaderId)	Gets a IContactProfileUploader object by the identifier within the IntegrationServer.
IContactProfileUploader	getContactProfileUploaderByTaskId(int contactProfileUploaderTaskId)	Returns a IContactProfileUploader object that previously has started an upload task in the Altitude uCI Server.
IContactProfileUploader[]	getContactProfileUploaders()	Gets the IContactProfileUploader objects.
Directory[]	getDirectories()	Gets the directories.
Directory	getDirectoryById(int directoryId)	Gets the specified directory.
Directory	getDirectoryByName(String directoryName)	Gets the specified directory.
String[]	getDirectoryNames()	Gets the names of the directories.
IInstance	getInstance()	The instance.
DirectoryRolePermission[]	getPermissions(String directoryName)	Gets the list of role permissions.
IContactProfileCursor	newContactProfileCursor(int directoryId, String[] columns, String sql)	Opens a contact profile cursor.
IContactProfileCursor	newContactProfileCursor(int directoryId, String[] columns, String sql, PurposeFilter purposeFilter)	Opens a contact profile cursor.
IContactProfileUploader	newContactProfileUploader(String directoryName)	Creates an IContactProfileUploader used to upload contact profiles.
IContactProfileCursor	tryGetContactProfileCursor(int cursorId)	Gets the contact profile cursor or null if the cursor does not exist.
void	updateContactProfileById(int directoryId, int contactProfileId, ContactProfileRequest request)	Updates a contact profile.
void	updateContactProfileByIdAttributes(int directoryId, int contactProfileId, Attribute[] values)	Updates a contact profile.
void	updateContactProfileByUniqueId(int directoryId, String uniqueId, ContactProfileRequest request)	Updates a contact profile.
void	updateContactProfileByUniqueIdAttributes(int directoryId, String uniqueId, Attribute[] values)	Updates a contact profile.
void	updateDirectory(String directoryName, DirectoryUpdateRequest request)	Updates a directory.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

createContactProfile

int createContactProfile(int directoryId,
 ContactProfileRequest request)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a contact profile.

Parameters:

directoryId - Identifier of the directory.

request - Contains the fields that must be overwritten

Returns:

The contact profile identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createContactProfileByAttributes

int createContactProfileByAttributes(int directoryId,
 Attribute[] values)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a contact profile.

Parameters:

directoryId - Identifier of the directory.

values - The contact profile data.

Returns:

The contact profile identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createDirectory

int createDirectory(DirectoryCreateRequest request)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a directory.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteContactProfileById

void deleteContactProfileById(int directoryId,
 int contactProfileId)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteContactProfileByUniqueId

void deleteContactProfileByUniqueId(int directoryId,
 String uniqueId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a contact profile.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteDirectory

void deleteDirectory(String directoryName)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a directory.

Parameters:

directoryName - Name of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileById

ContactProfile getContactProfileById(int directoryId,
 int contactProfileId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileById

ContactProfile getContactProfileById(int directoryId,
 int contactProfileId,
 PurposeFilter purposeFilter)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByIdAsAttributes

Attribute[] getContactProfileByIdAsAttributes(int directoryId,
 int contactProfileId,
 String[] columns)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile as attributes.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch. If null all columns are fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByIdAsAttributes

Attribute[] getContactProfileByIdAsAttributes(int directoryId,
 int contactProfileId,
 String[] columns,
 PurposeFilter purposeFilter)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile as attributes.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch. If null all columns are fetched.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByUniqueId

ContactProfile getContactProfileByUniqueId(int directoryId,
 String uniqueId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByUniqueId

ContactProfile getContactProfileByUniqueId(int directoryId,
 String uniqueId,
 PurposeFilter purposeFilter)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByUniqueIdAsAttributes

Attribute[] getContactProfileByUniqueIdAsAttributes(int directoryId,
 String uniqueId,
 String[] columns)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile as attributes.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

columns - Columns to fetch. If null all columns are fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileByUniqueIdAsAttributes

Attribute[] getContactProfileByUniqueIdAsAttributes(int directoryId,
 String uniqueId,
 String[] columns,
 PurposeFilter purposeFilter)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified contact profile as attributes.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

columns - Columns to fetch. If null all columns are fetched.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileCount

int getContactProfileCount(int directoryId,
 String sql)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile.

Parameters:

directoryId - Identifier of the directory.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileCursor

IContactProfileCursor getContactProfileCursor(int cursorId)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact profile cursor.

Parameters:

cursorId - Identifier of the cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldsFormatted

Attribute[] getContactProfileFieldsFormatted(int directoryId,
 int contactProfileId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the formatted contact profile fields.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldsFormatted

Attribute[] getContactProfileFieldsFormatted(int directoryId,
 int contactProfileId,
 PurposeFilter purposeFilter)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the formatted contact profile fields.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileTableSchema

TableSchema getContactProfileTableSchema(int directoryId)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile.

Parameters:

directoryId - Identifier of the directory.

Returns:

An array with the definition of each column of the contact profile table.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileUploaderById

IContactProfileUploader getContactProfileUploaderById(int contactProfileUploaderId)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a IContactProfileUploader object by the identifier within the IntegrationServer.

Parameters:

contactProfileUploaderId - Identifier of the IContactProfileUploader object.

Returns:

The IContactProfileUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileUploaderByTaskId

IContactProfileUploader getContactProfileUploaderByTaskId(int contactProfileUploaderTaskId)
                                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a IContactProfileUploader object that previously has started an upload task in the Altitude uCI Server.

Parameters:

contactProfileUploaderTaskId - Identifier of the entity upload task returned by the IContactProfileUploader.Start

Returns:

The IContactProfileUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileUploaders

IContactProfileUploader[] getContactProfileUploaders()
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the IContactProfileUploader objects.

Returns:

The IContactProfileUploader objects.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectories

Directory[] getDirectories()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the directories.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryById

Directory getDirectoryById(int directoryId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified directory.

Parameters:

directoryId - Identifier of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryByName

Directory getDirectoryByName(String directoryName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified directory.

Parameters:

directoryName - Name of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryNames

String[] getDirectoryNames()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the names of the directories.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPermissions

DirectoryRolePermission[] getPermissions(String directoryName)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of role permissions.

Parameters:

directoryName - Name of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newContactProfileCursor

IContactProfileCursor newContactProfileCursor(int directoryId,
 String[] columns,
 String sql)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile cursor.

Parameters:

directoryId - Identifier of the directory.

columns - Columns to fetch.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileCursor

IContactProfileCursor newContactProfileCursor(int directoryId,
 String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile cursor.

Parameters:

directoryId - Identifier of the directory.

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileUploader

IContactProfileUploader newContactProfileUploader(String directoryName)
                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Creates an IContactProfileUploader used to upload contact profiles.

Parameters:

directoryName - Name of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileCursor

IContactProfileCursor tryGetContactProfileCursor(int cursorId)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact profile cursor or null if the cursor does not exist.

Parameters:

cursorId - Identifier of the cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContactProfileById

void updateContactProfileById(int directoryId,
 int contactProfileId,
 ContactProfileRequest request)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

request - Describes what to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContactProfileByIdAttributes

void updateContactProfileByIdAttributes(int directoryId,
 int contactProfileId,
 Attribute[] values)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

values - The contact profile attributes to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContactProfileByUniqueId

void updateContactProfileByUniqueId(int directoryId,
 String uniqueId,
 ContactProfileRequest request)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a contact profile.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

request - Describes what to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContactProfileByUniqueIdAttributes

void updateContactProfileByUniqueIdAttributes(int directoryId,
 String uniqueId,
 Attribute[] values)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a contact profile.

Parameters:

directoryId - Identifier of the directory.

uniqueId - Unique identifier.

values - The contact profile attributes to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateDirectory

void updateDirectory(String directoryName,
 DirectoryUpdateRequest request)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a directory.

Parameters:

directoryName - Name of the directory.

request - Describes what to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException