org.assistments.domain.core

Class AssistmentsPrincipal

java.lang.Object

org.assistments.domain.core.XInfoImpl

org.assistments.domain.core.AssistmentsPrincipal

Type Parameters:

T -

All Implemented Interfaces:

java.lang.Comparable<AssistmentsPrincipal>, java.security.Principal, XInfo

Direct Known Subclasses:

Group, GroupRow, User

public abstract class AssistmentsPrincipal
extends XInfoImpl
implements java.lang.Comparable<AssistmentsPrincipal>, java.security.Principal

This interface represents the abstract notion of a principal representing an entity such as an ASSISTments user or a collection of users to be treated as a single unit. There is nothing that prevents a non-user based object from being treated as a principal, but at present that is not envisioned. Example of non-user principal: TODO

Nested Class Summary

Nested classes/interfaces inherited from class org.assistments.domain.core.XInfoImpl

XInfoImpl.XInfoState

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssistmentsPrincipal(PrincipalType pType)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asPrincipalString()
int	compareTo(AssistmentsPrincipal o)
boolean	equals(java.lang.Object obj) Returns whether two XInfos are equal based solely on the object's xref UUID.
int	getDbid()
java.lang.String	getName() Returns the AssistmentsPrincipal's common name.
PrincipalType	getPrincipalType()
boolean	isPrincipalType(PrincipalType type)
void	setDbid(int dbid)
void	setName(java.lang.String name) Sets this AssistmentsPrincipal's common name.
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent) Returns a String representation of this group's members formatted somewhat pretty.

Methods inherited from class org.assistments.domain.core.XInfoImpl

asXinfoString, clearXinfo, getState, getType, getXid, getXinfo, getXref, hashCode, setXid, setXidOverride, setXinfo, setXref

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

hashCode, implies

Constructor Detail

AssistmentsPrincipal

protected AssistmentsPrincipal(PrincipalType pType)

Method Detail

getPrincipalType

public PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface XInfo

Overrides:

getPrincipalType in class XInfoImpl

isPrincipalType

public boolean isPrincipalType(PrincipalType type)

getDbid

public int getDbid()

setDbid

public void setDbid(int dbid)

setName

public void setName(java.lang.String name)

Sets this AssistmentsPrincipal's common name.

Parameters:

name -

getName

public java.lang.String getName()

Returns the AssistmentsPrincipal's common name.

Specified by:

getName in interface java.security.Principal

compareTo

public final int compareTo(AssistmentsPrincipal o)

Specified by:

compareTo in interface java.lang.Comparable<AssistmentsPrincipal>

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: XInfo

Returns whether two XInfos are equal based solely on the object's xref UUID.

Specified by:

equals in interface java.security.Principal

Specified by:

equals in interface XInfo

Overrides:

equals in class XInfoImpl

asPrincipalString

public java.lang.String asPrincipalString()

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Specified by:

toString in interface XInfo

Overrides:

toString in class XInfoImpl

toString

public java.lang.String toString(java.lang.String indent)

Returns a String representation of this group's members formatted somewhat pretty.

Specified by:

toString in interface XInfo

Overrides:

toString in class XInfoImpl

Parameters:

indent - A String of one or more space characters to indent each level of nested groups and members.