org.pageseeder.bridge.model

Class PSMembership

java.lang.Object

org.pageseeder.bridge.model.PSMembership

All Implemented Interfaces:

Serializable, PSEntity

public final class PSMembership
extends Object
implements PSEntity

Since:

0.2.0

Version:

0.2.1

Author:

Christophe Lauret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PSMembership() Create a new membership without setting the group of member.
PSMembership(PSGroup group, PSMember member) Create a new membership.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkValid() Determines whether this object is valid based on known PageSeeder constraints.
Date	getCreated()
PSDetails	getDetails()
String	getField(int i) Shorthand method to get the detail field on that membership.
PSGroup	getGroup()
Long	getId()
String	getIdentifier() Returns the private ID only.
String	getKey()
PSMember	getMember()
PSNotification	getNotification()
PSRole	getRole()
boolean	isIdentifiable() Indicates whether the membership is identifiable.
boolean	isListed()
boolean	isValid() Determines whether the entity is valid based on known PageSeeder constraints.
void	setCreated(Date created)
void	setDetails(PSDetails details)
void	setField(int i, String value) Shorthand method to set the detail field on that membership.
void	setGroup(PSGroup group)
void	setId(Long id)
void	setListed(boolean listed)
void	setMember(PSMember member)
void	setNotification(PSNotification notification)
void	setRole(PSRole role)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSMembership

public PSMembership()

Create a new membership without setting the group of member.

PSMembership

public PSMembership(PSGroup group,
            PSMember member)

Create a new membership.

Parameters:

group - the PageSeeder group the member belongs to

member - the member instance

Method Detail

getId

public Long getId()

Specified by:

getId in interface PSEntity

Returns:

the PageSeeder id of the member.

getKey

public String getKey()

Specified by:

getKey in interface PSEntity

Returns:

the public ID for the PageSeeder entity.

isIdentifiable

public boolean isIdentifiable()

Indicates whether the membership is identifiable.

To be identifiable, the membership must have either PageSeeder database ID or it must have both a group and member defined and they both must be identifiable.

Specified by:

isIdentifiable in interface PSEntity

Returns:

true if ID is specified or both group and member are identifiable; false otherwise.

getIdentifier

public String getIdentifier()

Returns the private ID only.

Specified by:

getIdentifier in interface PSEntity

Returns:

The membership ID only if not null.

getGroup

public PSGroup getGroup()

Returns:

the group

getMember

public PSMember getMember()

Returns:

the member

isListed

public boolean isListed()

Returns:

the listed

getNotification

public PSNotification getNotification()

Returns:

the notification

getRole

public PSRole getRole()

Returns:

the role

getCreated

public Date getCreated()

Returns:

the date the membership was created

getDetails

public PSDetails getDetails()

Returns:

Membership detail fields if any

setId

public void setId(Long id)

Parameters:

id - the id to set

setGroup

public void setGroup(PSGroup group)

Parameters:

group - the group to set

setMember

public void setMember(PSMember member)

Parameters:

member - the member to set

setListed

public void setListed(boolean listed)

Parameters:

listed - the listed to set

setNotification

public void setNotification(PSNotification notification)

Parameters:

notification - the notification to set

setRole

public void setRole(PSRole role)

Parameters:

role - the role to set

setCreated

public void setCreated(Date created)

Parameters:

created - the date the membership was created.

setDetails

public void setDetails(PSDetails details)

Parameters:

details - Membership detail fields if any

getField

public String getField(int i)

Shorthand method to get the detail field on that membership.

Parameters:

i - the 1-based index of the field.

Returns:

the corresponding value if the membership has details and this field has a value.

Throws:

IndexOutOfBoundsException - If the index is less than 1 or greater than 15.

setField

public void setField(int i,
            String value)

Shorthand method to set the detail field on that membership.

If this membership has no details, this method will add a new empty PSDetails object.

Parameters:

i - the 1-based index of the field.

value - the value to set.

Throws:

IndexOutOfBoundsException - If the index is less than 1 or greater than 15.

checkValid

public EntityValidity checkValid()

Description copied from interface: PSEntity

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