com.liferay.user.associated.data.exporter

Interface UADExporter<T>

All Superinterfaces:

UADComponent<T>

All Known Implementing Classes:

DynamicQueryUADExporter

@ProviderType
public interface UADExporter<T>
extends UADComponent<T>

Handles converting the user-related type T entities into a format that can be written to a file and downloaded.

Method Summary

Modifier and Type	Method and Description
long	count(long userId) Returns the number of type T entities associated with the user.
byte[]	export(T t) Returns a byte array representing the entity, ready to be written to a file.
java.io.File	exportAll(long userId) Returns a file object containing the data from all type T entities related to the user.
default long	getExportDataCount(long userId) Returns the number of export data items of type T entities associated with the user.

Methods inherited from interface com.liferay.user.associated.data.component.UADComponent

getTypeClass

Method Detail

count

long count(long userId)
    throws PortalException

Returns the number of type T entities associated with the user.

Parameters:

userId - the primary key of the user whose data to count

Returns:

the number of entities associated with the user

Throws:

PortalException

export

byte[] export(T t)
       throws PortalException

Returns a byte array representing the entity, ready to be written to a file.

Parameters:

t - the type T entity to convert into a byte array

Returns:

a byte array representing the given entity

Throws:

PortalException - if a portal exception occurred

exportAll

java.io.File exportAll(long userId)
                throws PortalException

Returns a file object containing the data from all type T entities related to the user.

Parameters:

userId - the primary key of the user whose data to export

Returns:

a file containing the exported data

Throws:

PortalException - if a portal exception occurred

getExportDataCount

default long getExportDataCount(long userId)
                         throws PortalException

Returns the number of export data items of type T entities associated with the user.

Parameters:

userId - the primary key of the user whose data to count

Returns:

the number of export data items

Throws:

PortalException