Package org.bedework.calfacade.svc.wrappers

Class BwCalSuiteWrapper

java.lang.Object

org.bedework.calfacade.base.DumpEntity<T>

org.bedework.calfacade.base.BwUnversionedDbentity<T>

org.bedework.calfacade.base.BwDbentity<BwPrincipal<?>>

org.bedework.calfacade.BwPrincipal<T>

org.bedework.calfacade.BwShareablePrincipal<BwCalSuite>

org.bedework.calfacade.svc.BwCalSuite

org.bedework.calfacade.svc.wrappers.BwCalSuiteWrapper

All Implemented Interfaces:

Serializable, Comparable<BwPrincipal<?>>, Comparator<BwPrincipal<?>>, org.bedework.access.AccessPrincipal, OwnedEntity, ShareableEntity, EntityWrapper<BwCalSuite>, org.bedework.util.logging.Logged

public class BwCalSuiteWrapper
extends BwCalSuite
implements EntityWrapper<BwCalSuite>

This object represents a calendar suite in bedework. The calendar suites all share common data but have their own set of preferences associated with a run-as user.

Version:

1.0

Author:

Mike Douglass douglm@rpi.edu

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.bedework.calfacade.base.DumpEntity

DumpEntity.DumpType

Field Summary

Fields inherited from class org.bedework.calfacade.svc.BwCalSuite

fieldDelimiter, maxNameLength

Fields inherited from class org.bedework.calfacade.BwPrincipal

bwadmingroupPrincipalRoot, calsuitePrincipalRoot, categoryAccess, contactAccess, created, groupNames, groupPrincipalRoot, groups, hostPrincipalRoot, lastAccess, lastModify, locationAccess, logon, principalInfo, principalRoot, publicUser, publicUserHref, resourcePrincipalRoot, ticketPrincipalRoot, unauthenticated, userPrincipalRoot, venuePrincipalRoot

Constructor Summary

Constructors

Constructor	Description
BwCalSuiteWrapper()	Constructor
BwCalSuiteWrapper(BwCalSuite entity)	Constructor
BwCalSuiteWrapper(BwCalSuite entity, org.bedework.access.CurrentAccess currentAccess)	Constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()	Make visible
int	compareTo(BwPrincipal that)
BwCalSuite	fetchEntity()	Avoid get and set so we don't expose the underlying object to request streams.
String	getAccess()	Get the access
String	getContext()
String	getCreatorHref()
org.bedework.access.CurrentAccess	getCurrentAccess()
String	getDescription()
BwAdminGroup	getGroup()	Get the owning group
int	getId()
String	getName()	Get the name
String	getOwnerHref()
Boolean	getPublick()
String	getResourcesHome()	Path to the calendar home of the owning principal
BwCalendar	getRootCollection()	Get the root calendar
String	getRootCollectionPath()	Get the root collection path
int	getSeq()	Get the entity seq
int	hashCode()
boolean	isDefaultContext()
void	putEntity(BwCalSuite val)
void	setAccess(String val)	Set the access
void	setContext(String context)
void	setCreatorHref(String val)	Set the creator
void	setCurrentAccess(org.bedework.access.CurrentAccess val)	Only call for cloned object
void	setDefaultContext(boolean defaultContext)
void	setDescription(String val)
void	setGroup(BwAdminGroup val)	Set the owning group
void	setId(int val)
void	setName(String val)	Set the name
void	setOwnerHref(String val)	Set the owner
void	setPublick(Boolean val)
void	setResourcesHome(String val)	Path to the calendar home of the owning principal
void	setRootCollection(BwCalendar val)	Set the root calendar
void	setRootCollectionPath(String val)	Set the root collection path
void	setSeq(int val)	Set the seq for this entity
String	toString()

Methods inherited from class org.bedework.calfacade.svc.BwCalSuite

compare, getFields1, getFields2, getGroupHref, getPrincipalRef, setFields1, setFields2, setGroupHref, toStringSegment

Methods inherited from class org.bedework.calfacade.BwShareablePrincipal

copyTo, getCreatorEnt, getKind, setCreatorEnt

Methods inherited from class org.bedework.calfacade.BwPrincipal

addGroup, copyTo, equals, getAccount, getAccountNoSlash, getAccountSplit, getAclAccount, getCategoryAccess, getContactAccess, getCreated, getGroupNames, getGroups, getHref, getLastAccess, getLastModify, getLocationAccess, getLogon, getPrincipalInfo, getQuota, getRestoreCallback, getUnauthenticated, isPrincipal, makeGroupPrincipal, makeLocationPrincipal, makePrincipal, makePrincipal, makePrincipalHref, makeUserPrincipal, setAccount, setCategoryAccess, setContactAccess, setCreated, setGroupNames, setGroups, setHref, setKind, setLastAccess, setLastModify, setLocationAccess, setLogon, setPrincipalInfo, setPrincipalRef, setQuota, setUnauthenticated, toStringSegment

Methods inherited from class org.bedework.calfacade.base.BwDbentity

addDeletedEntity, afterDeletion, beforeDeletion, beforeSave, beforeUpdate, getByteSize, getDeletedEntities, length, setByteSize

Methods inherited from class org.bedework.calfacade.base.BwUnversionedDbentity

markUnsaved, unsaved

Methods inherited from class org.bedework.calfacade.base.DumpEntity

dump, dump, getLogger, hasDumpValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn

Constructor Details

BwCalSuiteWrapper

public BwCalSuiteWrapper()

Constructor

BwCalSuiteWrapper

public BwCalSuiteWrapper(BwCalSuite entity)

Constructor

Parameters:

entity - the wrapped entity

BwCalSuiteWrapper

public BwCalSuiteWrapper(BwCalSuite entity,
 org.bedework.access.CurrentAccess currentAccess)

Constructor

Parameters:

entity - the wrapped entity

currentAccess - access

Method Details

putEntity

public void putEntity(BwCalSuite val)

Specified by:

putEntity in interface EntityWrapper<BwCalSuite>

fetchEntity

public BwCalSuite fetchEntity()

Description copied from interface: EntityWrapper

Avoid get and set so we don't expose the underlying object to request streams.

Specified by:

fetchEntity in interface EntityWrapper<BwCalSuite>

Returns:

T

setId

public void setId(int val)

Overrides:

setId in class BwUnversionedDbentity<BwPrincipal<?>>

getId

public int getId()

Overrides:

getId in class BwUnversionedDbentity<BwPrincipal<?>>

Returns:

int id

setSeq

public void setSeq(int val)

Description copied from class: BwDbentity

Set the seq for this entity

Overrides:

setSeq in class BwDbentity<BwPrincipal<?>>

Parameters:

val - int seq

getSeq

public int getSeq()

Description copied from class: BwDbentity

Get the entity seq

Overrides:

getSeq in class BwDbentity<BwPrincipal<?>>

Returns:

int the entity seq

setOwnerHref

public void setOwnerHref(String val)

Set the owner

Specified by:

setOwnerHref in interface OwnedEntity

Overrides:

setOwnerHref in class BwShareablePrincipal<BwCalSuite>

Parameters:

val - String owner of the entity

getOwnerHref

public String getOwnerHref()

Specified by:

getOwnerHref in interface OwnedEntity

Overrides:

getOwnerHref in class BwShareablePrincipal<BwCalSuite>

Returns:

String owner of the entity

setPublick

public void setPublick(Boolean val)

Specified by:

setPublick in interface OwnedEntity

Overrides:

setPublick in class BwShareablePrincipal<BwCalSuite>

Parameters:

val - - true for public

getPublick

public Boolean getPublick()

Specified by:

getPublick in interface OwnedEntity

Overrides:

getPublick in class BwShareablePrincipal<BwCalSuite>

Returns:

boolean true for public

setCreatorHref

public void setCreatorHref(String val)

Description copied from interface: ShareableEntity

Set the creator

Specified by:

setCreatorHref in interface ShareableEntity

Overrides:

setCreatorHref in class BwShareablePrincipal<BwCalSuite>

Parameters:

val - String creator of the entity

getCreatorHref

public String getCreatorHref()

Specified by:

getCreatorHref in interface ShareableEntity

Overrides:

getCreatorHref in class BwShareablePrincipal<BwCalSuite>

Returns:

BwUser creator of the entity

setAccess

public void setAccess(String val)

Description copied from interface: ShareableEntity

Set the access

Specified by:

setAccess in interface ShareableEntity

Overrides:

setAccess in class BwShareablePrincipal<BwCalSuite>

Parameters:

val - String access

getAccess

public String getAccess()

Description copied from interface: ShareableEntity

Get the access

Specified by:

getAccess in interface ShareableEntity

Overrides:

getAccess in class BwShareablePrincipal<BwCalSuite>

Returns:

String access

setName

public void setName(String val)

Description copied from class: BwCalSuite

Set the name

Overrides:

setName in class BwCalSuite

Parameters:

val - String name

getName

public String getName()

Description copied from class: BwCalSuite

Get the name

Overrides:

getName in class BwCalSuite

Returns:

String name

getContext

public String getContext()

Overrides:

getContext in class BwCalSuite

Returns:

the name of the sub-context for this suite (may be null)

setContext

public void setContext(String context)

Overrides:

setContext in class BwCalSuite

Parameters:

context - the web context

isDefaultContext

public boolean isDefaultContext()

Overrides:

isDefaultContext in class BwCalSuite

Returns:

true if this is the default context

setDefaultContext

public void setDefaultContext(boolean defaultContext)

Overrides:

setDefaultContext in class BwCalSuite

Parameters:

defaultContext - the default web context

setGroup

public void setGroup(BwAdminGroup val)

Description copied from class: BwCalSuite

Set the owning group

Overrides:

setGroup in class BwCalSuite

Parameters:

val - BwAdminGroup group

getGroup

public BwAdminGroup getGroup()

Description copied from class: BwCalSuite

Get the owning group

Overrides:

getGroup in class BwCalSuite

Returns:

BwAdminGroup group

setRootCollectionPath

public void setRootCollectionPath(String val)

Description copied from class: BwCalSuite

Set the root collection path

Overrides:

setRootCollectionPath in class BwCalSuite

Parameters:

val - String rootCalendar path

getRootCollectionPath

public String getRootCollectionPath()

Description copied from class: BwCalSuite

Get the root collection path

Overrides:

getRootCollectionPath in class BwCalSuite

Returns:

String rootCollection path

setDescription

public void setDescription(String val)

Specified by:

setDescription in interface org.bedework.access.AccessPrincipal

Overrides:

setDescription in class BwCalSuite

getDescription

public String getDescription()

Specified by:

getDescription in interface org.bedework.access.AccessPrincipal

Overrides:

getDescription in class BwCalSuite

setRootCollection

public void setRootCollection(BwCalendar val)

Set the root calendar

Overrides:

setRootCollection in class BwCalSuite

Parameters:

val - BwCalendar rootCalendar

getRootCollection

public BwCalendar getRootCollection()

Get the root calendar

Overrides:

getRootCollection in class BwCalSuite

Returns:

BwCalendar rootCollection

setCurrentAccess

public void setCurrentAccess(org.bedework.access.CurrentAccess val)

Only call for cloned object

Parameters:

val - CurrentAccess

getCurrentAccess

public org.bedework.access.CurrentAccess getCurrentAccess()

Returns:

CurrentAccess

setResourcesHome

public void setResourcesHome(String val)

Path to the calendar home of the owning principal

Parameters:

val - path

getResourcesHome

public String getResourcesHome()

Path to the calendar home of the owning principal

Returns:

path

clone

public Object clone()

Description copied from class: BwUnversionedDbentity

Make visible

Overrides:

clone in class BwCalSuite

Returns:

Object of class T

compareTo

public int compareTo(BwPrincipal that)

Specified by:

compareTo in interface Comparable<BwPrincipal<?>>

Overrides:

compareTo in class BwPrincipal<BwCalSuite>

hashCode

public int hashCode()

Overrides:

hashCode in class BwCalSuite

toString

public String toString()

Overrides:

toString in class BwCalSuite