Package lumis.portal.group.databaseviewmembership

Class DatabaseViewGroupTypeConfig

java.lang.Object

lumis.portal.group.databaseviewmembership.DatabaseViewGroupTypeConfig

public class DatabaseViewGroupTypeConfig
extends Object

Contains the membership configuration for a group type that uses DatabaseViewGroupMembershipProvider.

Since:

4.2.1

Version:

$Revision: 10458 $ $Date: 2009-06-02 15:49:09 -0300 (Tue, 02 Jun 2009) $

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAMED_QUERY_FIND_BY_GROUP_TYPE_ID	Name of named query that returns DatabaseViewGroupTypeConfig filtering by parameter groupTypeId.

Constructor Summary

Constructors

Constructor	Description
DatabaseViewGroupTypeConfig()

Method Summary

Modifier and Type	Method	Description
int	getCacheMaxAgeSeconds()	Returns the membership cache maximum age.
String	getConnectionId()	Returns the connection identifier to use to access the view.
GroupType	getGroupType()	Returns the group type this configuration is for.
String	getId()	Returns the identifier for this instance.
String	getPrincipalShortIdField()	Returns the name of the field in the view that contains the principal short identifier.
Collection<DatabaseViewField>	getViewFields()	Returns the fields from the view that will be used to select the membership for groups.
String	getViewName()	Returns the view name.
void	setCacheMaxAgeSeconds(int cacheMaxAgeSeconds)	Sets the membership cache maximum age.
void	setConnectionId(String connectionId)	Sets the connection identifier to use to access the view.
void	setGroupType(GroupType groupType)	Sets the group type this configuration is for.
void	setPrincipalShortIdField(String principalShortIdField)	Sets the name of the field in the view that contains the principal short identifier.
void	setViewName(String viewName)	Sets the view name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMED_QUERY_FIND_BY_GROUP_TYPE_ID

public static final String NAMED_QUERY_FIND_BY_GROUP_TYPE_ID

Name of named query that returns DatabaseViewGroupTypeConfig filtering by parameter groupTypeId.

Since:

4.2.1

See Also:

Constant Field Values

Constructor Detail

DatabaseViewGroupTypeConfig

public DatabaseViewGroupTypeConfig()

Method Detail

getId

public String getId()

Returns the identifier for this instance.

Returns:

the identifier for this instance.

Since:

4.2.1

getConnectionId

public String getConnectionId()

Returns the connection identifier to use to access the view.

Returns:

the connection identifier.

Since:

4.2.1

See Also:

ITransaction.getByConnectionId(String)

setConnectionId

public void setConnectionId(String connectionId)

Sets the connection identifier to use to access the view.

Parameters:

connectionId - the connection identifier.

Since:

4.2.1

See Also:

ITransaction.getByConnectionId(String)

getViewName

public String getViewName()

Returns the view name.

Returns:

the view name.

Since:

4.2.1

setViewName

public void setViewName(String viewName)

Sets the view name.

Parameters:

viewName - the view name.

Since:

4.2.1

getPrincipalShortIdField

public String getPrincipalShortIdField()

Returns the name of the field in the view that contains the principal short identifier.

Returns:

the field name.

Since:

4.2.1

See Also:

PrincipalConfig.getShortId()

setPrincipalShortIdField

public void setPrincipalShortIdField(String principalShortIdField)

Sets the name of the field in the view that contains the principal short identifier.

Parameters:

principalShortIdField - the field name.

Since:

4.2.1

See Also:

PrincipalConfig.getShortId()

getCacheMaxAgeSeconds

public int getCacheMaxAgeSeconds()

Returns the membership cache maximum age.

Returns:

the membership cache maximum age, in seconds.

Since:

4.2.1

setCacheMaxAgeSeconds

public void setCacheMaxAgeSeconds(int cacheMaxAgeSeconds)

Sets the membership cache maximum age.

Parameters:

cacheMaxAgeSeconds - the maximum age, in seconds.

Since:

4.2.1

getGroupType

public GroupType getGroupType()

Returns the group type this configuration is for.

Returns:

the group type.

Since:

4.2.1

setGroupType

public void setGroupType(GroupType groupType)

Sets the group type this configuration is for.

Parameters:

groupType - the group type.

Since:

4.2.1

getViewFields

public Collection<DatabaseViewField> getViewFields()

Returns the fields from the view that will be used to select the membership for groups.

Returns:

the fields.

Since:

4.2.1