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

Interface RWikiObjectService

All Superinterfaces:

ContextObserver, EntityProducer, EntityTransferrer

public interface RWikiObjectService
extends EntityProducer, EntityTransferrer, ContextObserver

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_ID The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
static String	EVENT_RESOURCE_ADD Name of the event when creating a resource.
static String	EVENT_RESOURCE_READ Name of the event when reading a resource.
static String	EVENT_RESOURCE_REMOVE Name of the event when removing a resource.
static String	EVENT_RESOURCE_WRITE Name of the event when writing a resource.
static String	REFERENCE_LABEL This string starts the references to resources in this service.
static String	REFERENCE_ROOT This string starts the references to resources in this service.
static String	SMALL_CHANGE_IN_THREAD

Method Summary

Modifier and Type	Method and Description
boolean	checkAdmin(RWikiObject rwo) check for admin permission
boolean	checkRead(RWikiObject rwo) Check for read permission
boolean	checkUpdate(RWikiObject rwo) check for update permission
List	createListProxy(List commentsList, ObjectProxy lop) Create a list proxy based on the List and Object Proxy
RWikiObject	createNewRWikiCurrentObject() Creates a new rwiki Current Object according to the implementation
RWikiPermissions	createNewRWikiPermissionsImpl() Creates a new RWiki Permissions Bean
String	createReference(String pageName) generates a valid entity reference from the page name
boolean	exists(String name, String space) Does the page exist
List	findAllChangedSince(Date time, String basepath) Find all the changes under this point and under since the time specified
List	findAllPageNames() Find all pages in the database just reture
List	findChangedSince(Date since, String realm) A list of pages that have changed since (current versions)
List	findReferencingPages(String name) Finds pages that reference the given page name
List	findRWikiHistoryObjects(RWikiObject reference) get a list of all previous versions as RWikiHistoryObjects
List	findRWikiHistoryObjectsInReverse(RWikiObject rwo) Finds the history objects sorted in reverse order
List	findRWikiSubPages(String globalParentPageName) get list of subpages of the supplied page.
PageLinkRenderer	getComponentPageLinkRender(String pageSpace, boolean withBreadCrumb) gets a component page link renderer
Entity	getEntity(RWikiObject rwo) fetches the entity based on the RWikiObject
Map	getHandlers() A Map containing EntityHandlers for the Service, Each entity handler handles a subtype
Reference	getReference(RWikiObject rwo) Fetches the Reference Object from the Entity manager based on the RWikiObject
RWikiHistoryObject	getRWikiHistoryObject(RWikiObject refernceObject, int revision) Get a previous version
RWikiCurrentObject	getRWikiObject(RWikiObject reference) Gets the object based on the ID.
RWikiCurrentObject	getRWikiObject(String name, String realm) Gets the current object
RWikiCurrentObject	getRWikiObject(String name, String realm, RWikiObject ignore, String templateName) Gets the current object using a named template if it does not exist
void	revert(String name, String realm, Date version, int revision) Revert current revision to a named revision, creates a new revision
List	search(String criteria, String realm) Search on current objects
void	update(String name, String realm, Date version, RWikiPermissions permissions) Update the name page's permissions
void	update(String name, String realm, Date version, String content) Update the name page, no permissions
void	update(String name, String realm, Date version, String content, RWikiPermissions permissions) Update the named page, with permissions
void	updateNewComment(String name, String realm, Date version, String content) Updates and creates a new comment on the page

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer

archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getHttpAccess, getLabel, merge, parseEntityReference, willArchiveMerge

Methods inherited from interface org.sakaiproject.entity.api.EntityTransferrer

myToolIds, transferCopyEntities, transferCopyEntities

Methods inherited from interface org.sakaiproject.entity.api.ContextObserver

contextCreated, contextDeleted, contextUpdated, myToolIds

Field Detail

APPLICATION_ID

static final String APPLICATION_ID

The type string for this application: should not change over time as it may be stored in various parts of persistent entities.

REFERENCE_ROOT

static final String REFERENCE_ROOT

This string starts the references to resources in this service.

See Also:

Constant Field Values

REFERENCE_LABEL

static final String REFERENCE_LABEL

This string starts the references to resources in this service.

See Also:

Constant Field Values

EVENT_RESOURCE_ADD

static final String EVENT_RESOURCE_ADD

Name of the event when creating a resource.

See Also:

Constant Field Values

EVENT_RESOURCE_READ

static final String EVENT_RESOURCE_READ

Name of the event when reading a resource.

See Also:

Constant Field Values

EVENT_RESOURCE_WRITE

static final String EVENT_RESOURCE_WRITE

Name of the event when writing a resource.

See Also:

Constant Field Values

EVENT_RESOURCE_REMOVE

static final String EVENT_RESOURCE_REMOVE

Name of the event when removing a resource.

See Also:

Constant Field Values

SMALL_CHANGE_IN_THREAD

static final String SMALL_CHANGE_IN_THREAD

See Also:

Constant Field Values

Method Detail

getRWikiObject

RWikiCurrentObject getRWikiObject(String name,
                                  String realm)
                           throws PermissionException

Gets the current object

Parameters:

name -

realm -

Returns:

Throws:

PermissionException

getRWikiObject

RWikiCurrentObject getRWikiObject(String name,
                                  String realm,
                                  RWikiObject ignore,
                                  String templateName)
                           throws PermissionException

Gets the current object using a named template if it does not exist

Parameters:

name -

realm - the page space the page is in, used to localise and globalise the name

templateName -

Returns:

Throws:

PermissionException

getRWikiObject

RWikiCurrentObject getRWikiObject(RWikiObject reference)

Gets the object based on the ID. This

Parameters:

reference - the reference object

Returns:

search

List search(String criteria,
            String realm)
     throws PermissionException

Search on current objects

Parameters:

criteria -

realm -

Returns:

Throws:

PermissionException

update

void update(String name,
            String realm,
            Date version,
            String content,
            RWikiPermissions permissions)
     throws PermissionException,
            VersionException

Update the named page, with permissions

Parameters:

name -

realm -

version -

content -

permissions -

Throws:

PermissionException

VersionException

update

void update(String name,
            String realm,
            Date version,
            String content)
     throws PermissionException,
            VersionException

Update the name page, no permissions

Parameters:

name -

realm -

version -

content -

Throws:

PermissionException

VersionException

update

void update(String name,
            String realm,
            Date version,
            RWikiPermissions permissions)
     throws PermissionException,
            VersionException

Update the name page's permissions

Parameters:

name -

realm -

version -

permissions -

Throws:

PermissionException

VersionException

exists

boolean exists(String name,
               String space)

Does the page exist

Parameters:

name - A possibly non-globalised page name

space - Default space to globalise to

Returns:

findChangedSince

List findChangedSince(Date since,
                      String realm)

A list of pages that have changed since (current versions)

Parameters:

since -

realm -

Returns:

a list containing RWikiCurrentObjects

findReferencingPages

List findReferencingPages(String name)

Finds pages that reference the given page name

Parameters:

name -

Returns:

a non-null list of page names not rwikiObjects

revert

void revert(String name,
            String realm,
            Date version,
            int revision)

Revert current revision to a named revision, creates a new revision

Parameters:

name -

realm -

version -

revision -

getRWikiHistoryObject

RWikiHistoryObject getRWikiHistoryObject(RWikiObject refernceObject,
                                         int revision)

Get a previous version

Parameters:

referenceObject - the Rwiki object whore rwikiobjectid field will be used to locate the revision

revision -

Returns:

findRWikiHistoryObjects

List findRWikiHistoryObjects(RWikiObject reference)

get a list of all previous versions as RWikiHistoryObjects

Parameters:

id -

Returns:

findRWikiHistoryObjectsInReverse

List findRWikiHistoryObjectsInReverse(RWikiObject rwo)

Finds the history objects sorted in reverse order

Parameters:

rwo -

Returns:

findRWikiSubPages

List findRWikiSubPages(String globalParentPageName)

get list of subpages of the supplied page. The list will be alphabetiallcy sorted

Parameters:

globalParentPageName - is the page on which we want to find sub pages. THIS IS A GLOBAL NAME. DONT CONFUSE WITH A LOCAL NAME

Returns:

a list of pages sorted by name alphabetically.

updateNewComment

void updateNewComment(String name,
                      String realm,
                      Date version,
                      String content)
               throws PermissionException,
                      VersionException

Updates and creates a new comment on the page

Parameters:

name -

realm -

version -

content -

Throws:

PermissionException

VersionException

createListProxy

List createListProxy(List commentsList,
                     ObjectProxy lop)

Create a list proxy based on the List and Object Proxy

Parameters:

commentsList -

lop -

Returns:

createNewRWikiCurrentObject

RWikiObject createNewRWikiCurrentObject()

Creates a new rwiki Current Object according to the implementation

Returns:

createNewRWikiPermissionsImpl

RWikiPermissions createNewRWikiPermissionsImpl()

Creates a new RWiki Permissions Bean

Returns:

getEntity

Entity getEntity(RWikiObject rwo)

fetches the entity based on the RWikiObject

Parameters:

rwo -

Returns:

getReference

Reference getReference(RWikiObject rwo)

Fetches the Reference Object from the Entity manager based on the RWikiObject

Parameters:

rwo -

Returns:

getHandlers

Map getHandlers()

A Map containing EntityHandlers for the Service, Each entity handler handles a subtype

Returns:

findAllChangedSince

List findAllChangedSince(Date time,
                         String basepath)

Find all the changes under this point and under since the time specified

Parameters:

time - the time after which to consider changes

basepath - the base path

Returns:

a list of RWikiCurrentObjects

checkRead

boolean checkRead(RWikiObject rwo)

Check for read permission

Parameters:

rwo -

Returns:

checkUpdate

boolean checkUpdate(RWikiObject rwo)

check for update permission

Parameters:

rwo -

Returns:

checkAdmin

boolean checkAdmin(RWikiObject rwo)

check for admin permission

Parameters:

rwo -

Returns:

findAllPageNames

List findAllPageNames()

Find all pages in the database just reture

Returns:

createReference

String createReference(String pageName)

generates a valid entity reference from the page name

Parameters:

pageName -

Returns:

getComponentPageLinkRender

PageLinkRenderer getComponentPageLinkRender(String pageSpace,
                                            boolean withBreadCrumb)

gets a component page link renderer

Parameters:

pageSpace -

Returns: