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

Interface IDsucObject

All Known Subinterfaces:

IDsucDistList, IDsucGroup, IDsucRole, IDsucSet, IDsucUser

public interface IDsucObject

Method Summary

Modifier and Type	Method	Description
void	append(de.uplanet.jdbc.JdbcConnection p_conn, IDsRecord p_record)	insert a new record
void	delete(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)
IDsRecord	fromGuid(de.uplanet.jdbc.JdbcConnection p_conn, int p_iTypeId, String p_strGuid)
IDsRecord	fromGuid(de.uplanet.jdbc.JdbcConnection p_conn, int p_iTypeId, String p_strGuid, boolean p_bWithDisabledObjects)
IDsRecord	fromGuid(de.uplanet.jdbc.JdbcConnection p_conn, String p_strTypeId, String p_strGuid)
IDsRecord	fromGuid(de.uplanet.jdbc.JdbcConnection p_conn, String p_strTypeId, String p_strGuid, boolean p_bWithDisabledObjects)
String	getLastSQLStatement()
int	guidToId(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, int p_iType)
String	idToGuid(de.uplanet.jdbc.JdbcConnection p_conn, int p_iID)
void	move(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, String p_strToContainerGuid)
List<IDsObjectRecord>	select(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)	Select all objects in the ds manager.
List<IDsObjectRecord>	select(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)	Select all objects in the ds manager.
int	selectCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)	returns the count of records
int	selectCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)	returns the count of records
IDsObjectRecord	selectFullObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)	if a record is found, a valid type record instance is returned.
IDsObjectRecord	selectFullObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)	if a record is found, a valid type record instance is returned.
List<IDsObjectRecord>	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)	return a list of records.
List<IDsObjectRecord>	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)	return a list of records.
IDsObjectRecord	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid)	If a record is found, a valid type record instance is returned.
IDsObjectRecord	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects)	If a record is found, a valid type record instance is returned.
IDsObjectRecord	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, boolean p_bWithDisabledObjects, String... p_fieldGuids)	If a record is found, a valid type record instance is returned.
IDsObjectRecord	selectObject(de.uplanet.jdbc.JdbcConnection p_conn, String p_strGuid, String... p_fieldGuids)	If a record is found, a valid type record instance is returned.
int	selectObjectCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter)
int	selectObjectCount(de.uplanet.jdbc.JdbcConnection p_conn, IDsSelectFilter p_filter, boolean p_bWithDisabledObjects)
void	update(de.uplanet.jdbc.JdbcConnection p_conn, IDsRecord p_record)	Updates an existing record.

Method Detail

fromGuid

IDsRecord fromGuid(de.uplanet.jdbc.JdbcConnection p_conn,
                   int p_iTypeId,
                   String p_strGuid)
            throws SQLException

Parameters:

p_conn - The database connection

p_iTypeId - the object type id (-1 the base object type is used)

p_strGuid - The record guid

Returns:

a valid record instance or null if not found.

Throws:

SQLException

fromGuid

IDsRecord fromGuid(de.uplanet.jdbc.JdbcConnection p_conn,
                   int p_iTypeId,
                   String p_strGuid,
                   boolean p_bWithDisabledObjects)
            throws SQLException

Parameters:

p_conn - The database connection

p_iTypeId - the object type id (-1 the base object type is used)

p_strGuid - The record guid

Returns:

a valid record instance or null if not found.

Throws:

SQLException

fromGuid

IDsRecord fromGuid(de.uplanet.jdbc.JdbcConnection p_conn,
                   String p_strTypeId,
                   String p_strGuid)
            throws SQLException

Parameters:

p_conn - The database connection

p_strTypeId - The type id

p_strGuid - The record guid

Returns:

a valid record instance or null if not found

Throws:

SQLException

fromGuid

IDsRecord fromGuid(de.uplanet.jdbc.JdbcConnection p_conn,
                   String p_strTypeId,
                   String p_strGuid,
                   boolean p_bWithDisabledObjects)
            throws SQLException

Parameters:

p_conn - The database connection

p_strTypeId - The type id

p_strGuid - The record guid

p_bWithDisabledObjects - Disabled objects will be found, too

Returns:

a valid record instance or null if not found

Throws:

SQLException

append

void append(de.uplanet.jdbc.JdbcConnection p_conn,
            IDsRecord p_record)
     throws SQLException

insert a new record

Parameters:

p_conn - The database connection

p_record - the record, that will be inserted

Throws:

SQLException

update

void update(de.uplanet.jdbc.JdbcConnection p_conn,
            IDsRecord p_record)
     throws SQLException

Updates an existing record. If update fails, or physical record doesn't exist a DsRuntimeException will be thrown.

Parameters:

p_conn - The database connection

p_record - The record

Throws:

SQLException

delete

void delete(de.uplanet.jdbc.JdbcConnection p_conn,
            String p_strGuid)
     throws SQLException

Parameters:

p_conn - The database connection

p_strGuid - The record guid

Throws:

SQLException

move

void move(de.uplanet.jdbc.JdbcConnection p_conn,
          String p_strGuid,
          String p_strToContainerGuid)
   throws SQLException

Parameters:

p_conn - must not be null

p_strGuid - must not be null (and record must exist)

p_strToContainerGuid - can be null to move out record out of a contianer

Throws:

SQLException

selectCount

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

returns the count of records

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

Returns:

the count of records

Throws:

SQLException

selectCount

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

returns the count of records

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

the count of records

Throws:

SQLException

select

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

Select all objects in the ds manager. Beware to use without a filter, because the returned list size can be very big.

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

Returns:

list of records (not null, maybe empty)

Throws:

SQLException

select

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

Select all objects in the ds manager. Beware to use without a filter, because the returned list size can be very big.

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

p_bWithDisabledObjects - Disabled objects will be selected, too

Returns:

list of records (not null, maybe empty)

Throws:

SQLException

selectObjectCount

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

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

Returns:

the count of records

Throws:

SQLException

selectObjectCount

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

Parameters:

p_conn - The database connection

p_filter - The filter (could be null)

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

the count of records

Throws:

SQLException

selectObject

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

return a list of records.

Parameters:

p_conn - The database connection

p_filter - The filter

Returns:

list of records or an empty list if nothing is found. an record item of the list is of the correct record object instance. e.q. for a user type in the list, the list item is a instance of a IDsUserRecord object.

Throws:

SQLException

selectObject

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

return a list of records.

Parameters:

p_conn - The database connection

p_filter - The filter

p_bWithDisabledObjects - Should disabled objects be selected, too

Returns:

list of records or an empty list if nothing is found. an record item of the list is of the correct record object instance. e.q. for a user type in the list, the list item is a instance of a IDsUserRecord object.

Throws:

SQLException

selectFullObject

IDsObjectRecord selectFullObject(de.uplanet.jdbc.JdbcConnection p_conn,
                                 String p_strGuid)
                          throws SQLException

if a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. ALl fields from the DSObject are set. fields from a dsuser for example are not set.

Parameters:

p_conn - The database connection

p_strGuid - The guid

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

selectFullObject

IDsObjectRecord selectFullObject(de.uplanet.jdbc.JdbcConnection p_conn,
                                 String p_strGuid,
                                 boolean p_bWithDisabledObjects)
                          throws SQLException

if a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. ALl fields from the DSObject are set. fields from a dsuser for example are not set.

Parameters:

p_conn - The database connection

p_strGuid - The guid

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

selectObject

IDsObjectRecord selectObject(de.uplanet.jdbc.JdbcConnection p_conn,
                             String p_strGuid)
                      throws SQLException

If a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. The id, guid, type, containerid and name attributes are set.

Parameters:

p_conn - The database connection

p_strGuid - The guid

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

selectObject

IDsObjectRecord selectObject(de.uplanet.jdbc.JdbcConnection p_conn,
                             String p_strGuid,
                             boolean p_bWithDisabledObjects)
                      throws SQLException

If a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. The id, guid, type, containerid and name attributes are set.

Parameters:

p_conn - The database connection

p_strGuid - The guid

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

selectObject

IDsObjectRecord selectObject(de.uplanet.jdbc.JdbcConnection p_conn,
                             String p_strGuid,
                             String... p_fieldGuids)
                      throws SQLException

If a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. The id, guid, type, containerid and name attributes are set + the attributes given by the fieldGuids.

Parameters:

p_conn - The database connection

p_strGuid - The guid

p_fieldGuids - Array of field guids

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

selectObject

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

If a record is found, a valid type record instance is returned. e.q. for an container a IDsContainerRecord object. The id, guid, type, containerid and name attributes are set + the attributes given by the fieldGuids.

Parameters:

p_conn - The database connection

p_strGuid - The guid

p_fieldGuids - Array of field guids

p_bWithDisabledObjects - Should disabled objects be considered

Returns:

null if not found or a instance of an derived IDsObjectRecord object.

Throws:

SQLException

idToGuid

String idToGuid(de.uplanet.jdbc.JdbcConnection p_conn,
                int p_iID)
         throws SQLException

Parameters:

p_conn - The database connections

p_iID - The id to map

Returns:

The mapped guid.

Throws:

SQLException

guidToId

int guidToId(de.uplanet.jdbc.JdbcConnection p_conn,
             String p_strGuid,
             int p_iType)
      throws SQLException

Parameters:

p_conn - The connection

p_strGuid - The guid

p_iType - -1 if type should not check, otherwise the type of the record is checked. if checked and the returned type is not p_iType or the p_iType is not deriveable, a DSRuntimeExcepiton is thrown

Returns:

the id or -1 if not found

Throws:

SQLException

getLastSQLStatement

String getLastSQLStatement()

Returns:

The last sql statement.