org.pageseeder.bridge.model

Class PSGroup

java.lang.Object

org.pageseeder.bridge.model.PSGroup

All Implemented Interfaces:

Serializable, PSEntity

Direct Known Subclasses:

PSProject

public class PSGroup
extends Object
implements PSEntity

A PageSeeder group.

The public ID of a group is its name.

Since:

0.2.0

Version:

0.2.1

Author:

Christophe Lauret

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	RESERVED_GROUP_NAMES An unmodifiable list of names which cannot be used as group names.

Constructor Summary

Constructors

Constructor and Description
PSGroup() Create a new group without any identifier.
PSGroup(Long id) Create a new group from the specified ID.
PSGroup(String name) Create a new group with a public identifier.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkValid() Known constraints on Member are based on SQL definition:
PSNotification	getDefaultNotification() Returns the default notification assigned to members when they join the group.
PSRole	getDefaultRole() Returns the default role assigned to members when they join the group.
String	getDescription() Returns the description of this group.
String	getDetailsType() Returns the type of membership details for this group.
Long	getId()
String	getIdentifier() Returns the identifier to use when connecting to PageSeeder based on the ID available.
String	getKey()
String	getName() Returns the full name of the group.
String	getOwner() Returns the owner of the group.
String	getParentName() Returns the name of the parent project based on the name of this group.
String	getShortName() Returns the short name of this group.
String	getTemplate() Return the template folder for customizations (aka style owner).
boolean	isIdentifiable() Determines whether the entity can be identified in PageSeeder.
boolean	isValid() Determines whether the entity is valid based on known PageSeeder constraints.
static boolean	isValidGroupName(String name) Checks if given String is a valid group name.
void	setDefaultNotification(PSNotification notification) Returns the default notification assigned to members when they join the group.
void	setDefaultRole(PSRole role) Set the default role assigned to members when they join the group.
void	setDescription(String description) Sets the descriptions of this group.
void	setDetailsType(String type) Sets type of membership details for this group.
void	setId(Long id) Sets the PageSeeder ID of this group.
void	setName(String name) Sets the full name of this group.
void	setOwner(String owner) Sets the owner of the group.
void	setTemplate(String template) Set the style owner for this group.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_GROUP_NAMES

public static final Collection<String> RESERVED_GROUP_NAMES

An unmodifiable list of names which cannot be used as group names.

Constructor Detail

PSGroup

public PSGroup()

Create a new group without any identifier.

PSGroup

public PSGroup(Long id)

Create a new group from the specified ID.

Parameters:

id - The name of the group.

PSGroup

public PSGroup(String name)

Create a new group with a public identifier.

Note: the constructor does not check that the name is valid.

Parameters:

name - The name of the group.

Method Detail

getId

public Long getId()

Specified by:

getId in interface PSEntity

Returns:

the private ID of the PageSeeder entity in the database.

getKey

public String getKey()

Specified by:

getKey in interface PSEntity

Returns:

the public ID for the PageSeeder entity.

isIdentifiable

public boolean isIdentifiable()

Description copied from interface: PSEntity

Determines whether the entity can be identified in PageSeeder.

To be identifiable, the entity must have either a private id or a public id.

If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.

Specified by:

isIdentifiable in interface PSEntity

Returns:

true if the object can be identified in PageSeeder; false if it is not possible to identify the entity form its attributes or keys.

getIdentifier

public String getIdentifier()

Description copied from interface: PSEntity

Returns the identifier to use when connecting to PageSeeder based on the ID available.

When both the private and public identifier are available, the private identifier takes precedence over the public one.

When the public identifier cannot be used on its own, then only the private ID is returned.

In general, if the PSEntity.isIdentifiable() method return true, this method should return a value. When it is not the case, it should be clearly documented.

Specified by:

getIdentifier in interface PSEntity

Returns:

the identifier to use when connecting to PageSeeder.

getName

public String getName()

Returns the full name of the group.

Returns:

the name of the group.

getParentName

public String getParentName()

Returns the name of the parent project based on the name of this group.

The name of the parent is the part of the name that is before the last dash.

Returns:

the name of the parent or null if the name is null or does not include a dash.

getShortName

public String getShortName()

Returns the short name of this group.

The short name is the part of the name that is after the last dash.

Returns:

the short name or null if the name is null.

setId

public void setId(Long id)

Sets the PageSeeder ID of this group.

Parameters:

id - the id to set

setName

public void setName(String name)

Sets the full name of this group.

Parameters:

name - the name to set

getDescription

public final String getDescription()

Returns the description of this group.

Returns:

the description

setDescription

public final void setDescription(String description)

Sets the descriptions of this group.

Parameters:

description - the description to set

getDefaultRole

public final PSRole getDefaultRole()

Returns the default role assigned to members when they join the group.

Returns:

the default role assigned to members when they join the group.

getDefaultNotification

public final PSNotification getDefaultNotification()

Returns the default notification assigned to members when they join the group.

Returns:

the default notification assigned to members when they join the group.

setDefaultRole

public final void setDefaultRole(PSRole role)

Set the default role assigned to members when they join the group.

Parameters:

role - the default role assigned to members when they join the group.

setDefaultNotification

public final void setDefaultNotification(PSNotification notification)

Returns the default notification assigned to members when they join the group.

Parameters:

notification - the default notification assigned to members when they join the group.

getDetailsType

public String getDetailsType()

Returns the type of membership details for this group.

Returns:

the type of membership details for this group.

getTemplate

public String getTemplate()

Return the template folder for customizations (aka style owner).

Returns:

the style owner.

setDetailsType

public void setDetailsType(String type)

Sets type of membership details for this group.

The details type is the name of the configuration file defining the details to use in the group. For example, account.xml.

Parameters:

type - the type of membership details for this group.

setTemplate

public void setTemplate(String template)

Set the style owner for this group.

The style owner is the template folder for customizations

Parameters:

template - the style owner for this group.

getOwner

public String getOwner()

Returns the owner of the group.

Returns:

the owner of the group.

setOwner

public void setOwner(String owner)

Sets the owner of the group.

Parameters:

owner - the owner to set

checkValid

public EntityValidity checkValid()

Known constraints on Member are based on SQL definition:

  GroupName VARCHAR(60) NULL
  GroupDesc VARCHAR(250) NULL
  DetailsForm VARCHAR(150) NULL
  Owner VARCHAR(100) NULL
 

Determines whether this object is valid based on known PageSeeder constraints.

Specified by:

checkValid in interface PSEntity

Returns:

true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.

isValid

public boolean isValid()

Description copied from interface: PSEntity

Determines whether the entity is valid based on known PageSeeder constraints.

Specified by:

isValid in interface PSEntity

Returns:

true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.

toString

public String toString()

Overrides:

toString in class Object

isValidGroupName

public static boolean isValidGroupName(String name)

Checks if given String is a valid group name. Restrictions are: - first character is ALPHA - other characters are ALPHA / DIGIT / "_" / "~" / "-" - cannot contain "--" - not a reserved name

Parameters:

name - the group name to check.

Returns:

true if the group name is valid; false otherwise.