uk.ac.cam.caret.sakai.rwiki.service.api.model

Interface RWikiObject

All Superinterfaces:

Comparable

All Known Subinterfaces:

RWikiCurrentObject, RWikiHistoryObject

public interface RWikiObject
extends Comparable

The base object for a Wiki page, id, name, realm, permissions, revision, version, owner

Method Summary

Modifier and Type	Method and Description
void	copyAllTo(RWikiObject rwo) Copies everything
void	copyTo(RWikiObject rwo) Copy a RWikiObject into an existing RWiki Object This will copy the contents and settings of the RWiki Object into the supplied RWikiObject.
String	getContent() Access "serial number".
boolean	getGroupAdmin() can the group admin the page (set other permissions)
boolean	getGroupRead() can the group read the page
boolean	getGroupWrite() can the group edit the page
String	getId() Access the unique id.
String	getName() Access "name".
String	getOwner()
boolean	getOwnerAdmin() can the user admin the page (set other permissions)
boolean	getOwnerRead() Can the user read the page
boolean	getOwnerWrite() can the user edit the page
RWikiPermissions	getPermissions() get an object containing the current state of the permissions, this MUST be pushed back into the DAO for the changes to take effect.
boolean	getPublicRead() Can the public read the page
boolean	getPublicWrite() can the public edit the page
String	getRealm() Access "rank".
String	getReferenced() a list of referenced pages seperated by ::
Integer	getRevision()
String	getRwikiobjectid() The parent rwiki object
String	getSha1() get the hash
String	getSource()
String	getUser()
Date	getVersion() Access the object's version time stamp.
void	setContent(String sn) Set the "serial number".
void	setGroupAdmin(boolean groupAdmin) set the group admin permissoins
void	setGroupRead(boolean groupRead) set the group permission
void	setGroupWrite(boolean groupWrite) set the group edit
void	setId(String id) Set the ID, ONLY do this if you really know you must.
void	setName(String name) Set the "name".
void	setOwner(String owner) The user that owns this record
void	setOwnerAdmin(boolean ownerAdmin) Can the user set admin permissions, (set other permissions, including this one, potential lock out so we need a higher level admin )
void	setOwnerRead(boolean ownerRead) set what the owner can do to the page, requires admin for the user
void	setOwnerWrite(boolean ownerWrite) set the user edit permission
void	setPermissions(RWikiPermissions permissions) Update permissions, the permission array must be of length 8
void	setPublicRead(boolean publicRead) set the public read permissions
void	setPublicWrite(boolean publicWrite) set the public edit permissions
void	setRealm(String rank) Set the "rank".
void	setReferenced(String referenced) a list of referenced pages seperated by ::
void	setRevision(Integer revision)
void	setRwikiobjectid(String rwikiobjectid) The id of the rwiki object which this is a version of
void	setSha1(String sha1) set the hash.
void	setUser(String user) The user that last edited this record
void	setVersion(Date version) Set the "version"

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

String getId()

Access the unique id.

Returns:

The unique id.

setId

void setId(String id)

Set the ID, ONLY do this if you really know you must.

getVersion

Date getVersion()

Access the object's version time stamp.

Returns:

The object's version time stamp.

setVersion

void setVersion(Date version)

Set the "version"

Parameters:

version - The new "version".

getName

String getName()

Access "name".

Returns:

"name".

setName

void setName(String name)

Set the "name".

Parameters:

name - The new "name".

getRealm

String getRealm()

Access "rank".

Returns:

"rank".

setRealm

void setRealm(String rank)

Set the "rank".

Parameters:

rank - The new "rank".

getContent

String getContent()

Access "serial number".

Returns:

"serial number".

getReferenced

String getReferenced()

a list of referenced pages seperated by ::

Returns:

setReferenced

void setReferenced(String referenced)

a list of referenced pages seperated by ::

setContent

void setContent(String sn)

Set the "serial number".

Parameters:

sn - The new "serial number".

setUser

void setUser(String user)

The user that last edited this record

Parameters:

user -

getUser

String getUser()

Returns:

The user that last edited this record

setOwner

void setOwner(String owner)

The user that owns this record

getOwner

String getOwner()

Returns:

The user that owns this record

getOwnerRead

boolean getOwnerRead()

Can the user read the page

Returns:

setOwnerRead

void setOwnerRead(boolean ownerRead)

set what the owner can do to the page, requires admin for the user

Parameters:

userRead -

getOwnerWrite

boolean getOwnerWrite()

can the user edit the page

Returns:

setOwnerWrite

void setOwnerWrite(boolean ownerWrite)

set the user edit permission

Parameters:

userWrite -

getOwnerAdmin

boolean getOwnerAdmin()

can the user admin the page (set other permissions)

Returns:

setOwnerAdmin

void setOwnerAdmin(boolean ownerAdmin)

Can the user set admin permissions, (set other permissions, including this one, potential lock out so we need a higher level admin )

Parameters:

userAdmin -

getGroupRead

boolean getGroupRead()

can the group read the page

Returns:

setGroupRead

void setGroupRead(boolean groupRead)

set the group permission

Parameters:

groupRead -

getGroupWrite

boolean getGroupWrite()

can the group edit the page

Returns:

setGroupWrite

void setGroupWrite(boolean groupWrite)

set the group edit

Parameters:

groupWrite -

getGroupAdmin

boolean getGroupAdmin()

can the group admin the page (set other permissions)

Returns:

setGroupAdmin

void setGroupAdmin(boolean groupAdmin)

set the group admin permissoins

Parameters:

groupAdmin -

getPublicRead

boolean getPublicRead()

Can the public read the page

Returns:

setPublicRead

void setPublicRead(boolean publicRead)

set the public read permissions

Parameters:

publicRead -

getPublicWrite

boolean getPublicWrite()

can the public edit the page

Returns:

setPublicWrite

void setPublicWrite(boolean publicWrite)

set the public edit permissions

Parameters:

publicWrite -

getRevision

Integer getRevision()

Returns:

Returns the revision number

setRevision

void setRevision(Integer revision)

copyTo

void copyTo(RWikiObject rwo)

Copy a RWikiObject into an existing RWiki Object This will copy the contents and settings of the RWiki Object into the supplied RWikiObject. The ID and the User will not be changed, everything else will be coppied. NB. THE GLOBAL NAME, AND REALM WILL NOT BE COPIED, and should be changed by the calling method.

copyAllTo

void copyAllTo(RWikiObject rwo)

Copies everything

Parameters:

rwo -

setPermissions

void setPermissions(RWikiPermissions permissions)

Update permissions, the permission array must be of length 8

getPermissions

RWikiPermissions getPermissions()

get an object containing the current state of the permissions, this MUST be pushed back into the DAO for the changes to take effect. Changing the contents of RWikiPermissions is not sufficient.

Returns:

setRwikiobjectid

void setRwikiobjectid(String rwikiobjectid)

The id of the rwiki object which this is a version of

Parameters:

rwikiobjectid -

getRwikiobjectid

String getRwikiobjectid()

The parent rwiki object

Returns:

getSha1

String getSha1()

get the hash

Returns:

setSha1

void setSha1(String sha1)

set the hash.

Parameters:

sha1 -

getSource

String getSource()

Returns: