Package org.apache.fulcrum.security.torque.peer

Interface TurbineUserGroupRoleModelPeerMapper

All Known Implementing Classes:

TorqueTurbineUserGroupRole, TurbineUserGroupRole

public interface TurbineUserGroupRoleModelPeerMapper

This interface allows to retrieve user, group, role relationships either from custom or the default OM in It should be implemented by appopriate om classes (interface may be set in schema).

Author:

gk

Method Summary

Modifier and Type	Method	Description
Group	getTurbineGroup()	Returns the associated TurbineGroup object.
Group	getTurbineGroup(Connection connection)	Return the associated TurbineGroup object If it was not retrieved before, the object is retrieved from the database using the passed connection
Role	getTurbineRole()	Returns the associated TurbineRole object.
Role	getTurbineRole(Connection connection)	Return the associated TurbineRole object If it was not retrieved before, the object is retrieved from the database using the passed connection
User	getTurbineUser()	Returns the associated TurbineUser object.
User	getTurbineUser(Connection connection)	Return the associated TurbineUser object If it was not retrieved before, the object is retrieved from the database using the passed connection

Method Detail

getTurbineUser

User getTurbineUser()
             throws org.apache.torque.TorqueException

Returns the associated TurbineUser object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated TurbineUser object

Throws:

org.apache.torque.TorqueException - if any database error occurs when reading from the database fails.

getTurbineUser

User getTurbineUser(Connection connection)
             throws org.apache.torque.TorqueException

Return the associated TurbineUser object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated TurbineUser object

Throws:

org.apache.torque.TorqueException - if any database error occurs

getTurbineGroup

Group getTurbineGroup()
               throws org.apache.torque.TorqueException

Returns the associated TurbineGroup object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated TurbineGroup object

Throws:

org.apache.torque.TorqueException - if any database error occurs when reading from the database fails.

getTurbineGroup

Group getTurbineGroup(Connection connection)
               throws org.apache.torque.TorqueException

Return the associated TurbineGroup object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated TurbineGroup object

Throws:

org.apache.torque.TorqueException - if any database error occurs

getTurbineRole

Role getTurbineRole()
             throws org.apache.torque.TorqueException

Returns the associated TurbineRole object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated TurbineRole object

Throws:

org.apache.torque.TorqueException - if any database error occurs when reading from the database fails.

getTurbineRole

Role getTurbineRole(Connection connection)
             throws org.apache.torque.TorqueException

Return the associated TurbineRole object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated TurbineRole object

Throws:

org.apache.torque.TorqueException - if any database error occurs