Package de.uplanet.lucy.server.usermanager.usecases

Interface IDsucSet

All Superinterfaces:

IDsucObject

All Known Subinterfaces:

IDsucDistList, IDsucGroup, IDsucRole

public interface IDsucSet
extends IDsucObject

Method Summary

Modifier and Type	Method	Description
void	addMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid, int... p_ids)
void	addMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid, String... p_guids)
void	clearMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid)	removes all members from a given set
List<IDsObjectRecord>	getMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid, IDsSelectFilter p_filter)
int	getMembersCount(de.uplanet.jdbc.JdbcConnection p_strConn, String p_strSetGuid, IDsSelectFilter p_selectFilter)
void	removeMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid, int... p_ids)
void	removeMembers(de.uplanet.jdbc.JdbcConnection p_conn, String p_strSetGuid, String... p_guids)
List<IDsSetRecord>	selectContainingSets(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)	Get a list of set records that contain the object given by the guid (records that are not deleted and not disabled).
List<IDsSetRecord>	selectContainingSets(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)	Get a list of set records that contain the object given by the guid (records that are not deleted and not disabled).
SortedSet<String>	selectContainingSetsGuids(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)	Get a lexocographically sorted set of set GUIDs that contain the object given by the GUID (sets that are neither deleted nor disabled).
SortedSet<String>	selectContainingSetsGuids(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)	Get a lexocographically sorted set of set GUIDs that contain the object given by the GUID (sets that are neither deleted).
IDsSetRecord	selectFullSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)
IDsSetRecord	selectFullSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)
List<IDsSetRecord>	selectNotContainingSets(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)	Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).
List<IDsSetRecord>	selectNotContainingSets(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)	Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).
List<IDsSetRecord>	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)
List<IDsSetRecord>	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)
IDsSetRecord	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)
IDsSetRecord	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)
IDsSetRecord	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects, String... p_fieldGuids)
IDsSetRecord	selectSet(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, String... p_fieldGuids)
int	selectSetCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)
int	selectSetCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)
List<IDsSetRecord>	selectSetsContains(de.uplanet.jdbc.JdbcConnection p_conn, int p_iUserId)
List<IDsSetRecord>	selectSetsContains(de.uplanet.jdbc.JdbcConnection p_conn, int p_iUserId, boolean p_bWithDisabledObjects)
List<IDsSetRecord>	selectSetsContainsNot(de.uplanet.jdbc.JdbcConnection p_conn, int p_iUserId)	Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).
List<IDsSetRecord>	selectSetsContainsNot(de.uplanet.jdbc.JdbcConnection p_conn, int p_iUserId, boolean p_bWithDisabledObjects)	Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).

Methods inherited from interface de.uplanet.lucy.server.usermanager.usecases.IDsucObject

append, delete, fromGuid, fromGuid, fromGuid, fromGuid, getLastSQLStatement, guidToId, idToGuid, move, select, select, selectCount, selectCount, selectFullObject, selectFullObject, selectObject, selectObject, selectObject, selectObject, selectObject, selectObject, selectObjectCount, selectObjectCount, update

Method Detail

selectSetCount

int selectSetCount(de.uplanet.jdbc.JdbcConnection p_conn,
                   IDsSelectFilter p_filter)
            throws SQLException

Parameters:

p_conn - database connection

p_filter - can be null

Returns:

count of sets

Throws:

SQLException

selectSetCount

int selectSetCount(de.uplanet.jdbc.JdbcConnection p_conn,
                   IDsSelectFilter p_filter,
                   boolean p_bWithDisabledObjects)
            throws SQLException

Parameters:

p_conn - database connection

p_filter - can be null

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

count of sets

Throws:

SQLException

selectSet

List<IDsSetRecord> selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                             IDsSelectFilter p_filter)
                      throws SQLException

Parameters:

p_conn -

p_filter - can be null, or the filter settings are used for the select

Returns:

List of set records (not null, may be empty).

Throws:

SQLException

selectSet

List<IDsSetRecord> selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                             IDsSelectFilter p_filter,
                             boolean p_bWithDisabledObjects)
                      throws SQLException

Parameters:

p_conn -

p_filter - can be null, or the filter settings are used for the select

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

List of set records (not null, may be empty).

Throws:

SQLException

selectFullSet

IDsSetRecord selectFullSet(de.uplanet.jdbc.JdbcConnection p_conn,
                           String p_strGuid)
                    throws SQLException

Parameters:

p_conn -

p_strGuid -

Returns:

a full readed set record, or null if no set record found for the guid

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

selectFullSet

IDsSetRecord selectFullSet(de.uplanet.jdbc.JdbcConnection p_conn,
                           String p_strGuid,
                           boolean p_bWithDisabledObjects)
                    throws SQLException

Parameters:

p_conn -

p_strGuid -

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

a full readed set record, or null if no set record found for the guid

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

selectSet

IDsSetRecord selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                       String p_strGuid)
                throws SQLException

Parameters:

p_conn -

p_strGuid -

Returns:

the set record(id, guid, containerguid,containerid and name columns are set) or null if no record is found

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

selectSet

IDsSetRecord selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                       String p_strGuid,
                       boolean p_bWithDisabledObjects)
                throws SQLException

Parameters:

p_conn -

p_strGuid -

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

the set record(id, guid, containerguid,containerid and name columns are set) or null if no record is found

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

selectSet

IDsSetRecord selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                       String p_strGuid,
                       String... p_fieldGuids)
                throws SQLException

Parameters:

p_conn -

p_strGuid -

p_fieldGuids -

Returns:

a set record (id,containerid, containerguid, name + column given by the field guids are set) or null if no set found for the given guid

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

selectSet

IDsSetRecord selectSet(de.uplanet.jdbc.JdbcConnection p_conn,
                       String p_strGuid,
                       boolean p_bWithDisabledObjects,
                       String... p_fieldGuids)
                throws SQLException

Parameters:

p_conn -

p_strGuid -

p_bWithDisabledObjects - Should disabled objects be considered

p_fieldGuids -

Returns:

a set record (id,containerid, containerguid, name + column given by the field guids are set) or null if no set found for the given guid

Throws:

SQLException

de.uplanet.lucy.usermanager.DsRuntimeException - a record for the guid exists, but is not of a type of a set

getMembers

List<IDsObjectRecord> getMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                                 String p_strSetGuid,
                                 IDsSelectFilter p_filter)
                          throws SQLException

Parameters:

p_conn -

p_strSetGuid -

p_filter - can be null

Returns:

list of member records, empty list if the set has no member

Throws:

SQLException

addMembers

void addMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                String p_strSetGuid,
                String... p_guids)
         throws SQLException

Parameters:

p_conn -

p_strSetGuid - if no set found with that guid, a warning is written to the log

p_guids - guids to add

Throws:

SQLException

addMembers

void addMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                String p_strSetGuid,
                int... p_ids)
         throws SQLException

Parameters:

p_conn -

p_strSetGuid - if no set found with that guid, a warning is written to the log

p_ids - the ids added to the set

Throws:

SQLException

removeMembers

void removeMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                   String p_strSetGuid,
                   String... p_guids)
            throws SQLException

Parameters:

p_conn -

p_strSetGuid - if no set found for that guid, a warning is written to the log.

p_guids - the member GUIDs to remove

Throws:

SQLException

removeMembers

void removeMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                   String p_strSetGuid,
                   int... p_ids)
            throws SQLException

Parameters:

p_conn -

p_strSetGuid - if no set found for that GUID, a warning is written to the log.

p_ids - the member ids to remove

Throws:

SQLException

clearMembers

void clearMembers(de.uplanet.jdbc.JdbcConnection p_conn,
                  String p_strSetGuid)
           throws SQLException

removes all members from a given set

Parameters:

p_conn -

p_strSetGuid - if no set found for that GUID, a warning is written to the log.

Throws:

SQLException

getMembersCount

int getMembersCount(de.uplanet.jdbc.JdbcConnection p_strConn,
                    String p_strSetGuid,
                    IDsSelectFilter p_selectFilter)
             throws SQLException

Parameters:

p_strConn -

p_strSetGuid - if no set found for

p_selectFilter - can be null

Returns:

count of members

Throws:

SQLException

selectContainingSets

List<IDsSetRecord> selectContainingSets(de.uplanet.jdbc.JdbcConnection p_conn,
                                        String p_strGuid)
                                 throws SQLException

Get a list of set records that contain the object given by the guid (records that are not deleted and not disabled).

Returns:

A list of records typeof IDsSetRecord or an derived type (not null, may be empty). (PrimaryKey, ClassId, ContainerID, ContainerGuid, Name, ClassId, Guid, Disabled, Deleted)

Throws:

SQLException

selectContainingSets

List<IDsSetRecord> selectContainingSets(de.uplanet.jdbc.JdbcConnection p_conn,
                                        String p_strGuid,
                                        boolean p_bWithDisabledObjects)
                                 throws SQLException

Get a list of set records that contain the object given by the guid (records that are not deleted and not disabled).

Returns:

A list of records typeof IDsSetRecord or an derived type (not null, may be empty). (PrimaryKey, ClassId, ContainerID, ContainerGuid, Name, ClassId, Guid, Disabled, Deleted)

Throws:

SQLException

selectContainingSetsGuids

SortedSet<String> selectContainingSetsGuids(de.uplanet.jdbc.JdbcConnection p_conn,
                                            String p_strGuid)
                                     throws SQLException

Get a lexocographically sorted set of set GUIDs that contain the object given by the GUID (sets that are neither deleted nor disabled).

Returns:

A possibly empty set of GUIDs.

Throws:

SQLException

selectContainingSetsGuids

SortedSet<String> selectContainingSetsGuids(de.uplanet.jdbc.JdbcConnection p_conn,
                                            String p_strGuid,
                                            boolean p_bWithDisabledObjects)
                                     throws SQLException

Get a lexocographically sorted set of set GUIDs that contain the object given by the GUID (sets that are neither deleted).

Returns:

A possibly empty set of GUIDs.

Throws:

SQLException

selectSetsContains

List<IDsSetRecord> selectSetsContains(de.uplanet.jdbc.JdbcConnection p_conn,
                                      int p_iUserId)
                               throws SQLException

Parameters:

p_conn - The connection

p_iUserId - The user id

Returns:

List of IDsSetRecords

Throws:

SQLException

selectSetsContains

List<IDsSetRecord> selectSetsContains(de.uplanet.jdbc.JdbcConnection p_conn,
                                      int p_iUserId,
                                      boolean p_bWithDisabledObjects)
                               throws SQLException

Parameters:

p_conn - The connection

p_iUserId - The user id

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

List of IDsSetRecords

Throws:

SQLException

selectNotContainingSets

List<IDsSetRecord> selectNotContainingSets(de.uplanet.jdbc.JdbcConnection p_conn,
                                           String p_strGuid)
                                    throws SQLException

Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).

Returns:

A list of records type of IDsSetRecord or an derived type. (PrimaryKey, ClassId,ContainerID, ContainerGuid, Name, ClassId, GUID, Disabled, Deleted)

Throws:

SQLException

selectSetsContainsNot

List<IDsSetRecord> selectSetsContainsNot(de.uplanet.jdbc.JdbcConnection p_conn,
                                         int p_iUserId)
                                  throws SQLException

Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).

Returns:

A list of records typeof IDsSetRecord or an derived type. (PrimaryKey, ClassId,ContainerID, ContainerGuid, Name, ClassId, Guid, Disabled, Deleted)

Throws:

SQLException

selectSetsContainsNot

List<IDsSetRecord> selectSetsContainsNot(de.uplanet.jdbc.JdbcConnection p_conn,
                                         int p_iUserId,
                                         boolean p_bWithDisabledObjects)
                                  throws SQLException

Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).

Returns:

A list of records type of IDsSetRecord or an derived type. (PrimaryKey, ClassId,ContainerID, ContainerGuid, Name, ClassId, Guid, Disabled, Deleted)

Throws:

SQLException

selectNotContainingSets

List<IDsSetRecord> selectNotContainingSets(de.uplanet.jdbc.JdbcConnection p_conn,
                                           String p_strGuid,
                                           boolean p_bWithDisabledObjects)
                                    throws SQLException

Get a list of set records that contains not the object given by the id (records that are not deleted and not disabled).

Returns:

A list of records type of IDsSetRecord or an derived type. (PrimaryKey, ClassId,ContainerID, ContainerGuid, Name, ClassId, Guid, Disabled, Deleted)

Throws:

SQLException